<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
  <head><meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html"><link rel="search" title="Search" href="search.html"><link rel="prev" title="OSXPhotos Python API" href="API_README.html">

    <!-- Generated with Sphinx 8.2.3 and Furo 2025.09.25 -->
        <title>OSXPhotos Python Reference - osxphotos 0.74.2 documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
    <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=580074bf" />
    <link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
    <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
    
    


<style>
  body {
    --color-code-background: #f2f2f2;
  --color-code-foreground: #1e1e1e;
  
  }
  @media not print {
    body[data-theme="dark"] {
      --color-code-background: #202020;
  --color-code-foreground: #d0d0d0;
  
    }
    @media (prefers-color-scheme: dark) {
      body:not([data-theme="light"]) {
        --color-code-background: #202020;
  --color-code-foreground: #d0d0d0;
  
      }
    }
  }
</style></head>
  <body>
    
    <script>
      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
    </script>
    

<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
  <symbol id="svg-toc" viewBox="0 0 24 24">
    <title>Contents</title>
    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
    </svg>
  </symbol>
  <symbol id="svg-menu" viewBox="0 0 24 24">
    <title>Menu</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
      <line x1="3" y1="12" x2="21" y2="12"></line>
      <line x1="3" y1="6" x2="21" y2="6"></line>
      <line x1="3" y1="18" x2="21" y2="18"></line>
    </svg>
  </symbol>
  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
    <title>Expand</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
      <polyline points="9 18 15 12 9 6"></polyline>
    </svg>
  </symbol>
  <symbol id="svg-sun" viewBox="0 0 24 24">
    <title>Light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
      <circle cx="12" cy="12" r="5"></circle>
      <line x1="12" y1="1" x2="12" y2="3"></line>
      <line x1="12" y1="21" x2="12" y2="23"></line>
      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
      <line x1="1" y1="12" x2="3" y2="12"></line>
      <line x1="21" y1="12" x2="23" y2="12"></line>
      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
    </svg>
  </symbol>
  <symbol id="svg-moon" viewBox="0 0 24 24">
    <title>Dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
    </svg>
  </symbol>
  <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
    <title>Auto light/dark, in light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
      <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
      <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
      <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
      <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
      <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
      <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
      <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
      <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
      <circle cx="14.5" cy="9.55" r="3.6"/>
    </svg>
  </symbol>
  <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
    <title>Auto light/dark, in dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
      <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
      <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
      <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
      <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
      <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
      <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
      <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
      <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
      <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
    </svg>
  </symbol>
  <symbol id="svg-pencil" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
      <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
      <path d="M13.5 6.5l4 4" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
  <symbol id="svg-eye" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
      <path
        d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
</svg>

<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>



<div class="page">
  <header class="mobile-header">
    <div class="header-left">
      <label class="nav-overlay-icon" for="__navigation">
        <span class="icon"><svg><use href="#svg-menu"></use></svg></span>
      </label>
    </div>
    <div class="header-center">
      <a href="index.html"><div class="brand">osxphotos 0.74.2 documentation</div></a>
    </div>
    <div class="header-right">
      <div class="theme-toggle-container theme-toggle-header">
        <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
        </button>
      </div>
      <label class="toc-overlay-icon toc-header-icon" for="__toc">
        <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
      </label>
    </div>
  </header>
  <aside class="sidebar-drawer">
    <div class="sidebar-container">
      
      <div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
  
  <span class="sidebar-brand-text">osxphotos 0.74.2 documentation</span>
  
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
  <input type="hidden" name="check_keywords" value="yes">
  <input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
  <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">OSXPhotos</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">OSXPhotos Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli.html">OSXPhotos Command Line Interface (CLI)</a></li>
<li class="toctree-l1"><a class="reference internal" href="template_help.html">OSXPhotos Template System</a></li>
<li class="toctree-l1"><a class="reference internal" href="package_overview.html">OSXPhotos Python Package Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="API_README.html">OSXPhotos Python API</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">OSXPhotos Python Reference</a></li>
</ul>

</div>
</div>

      </div>
      
    </div>
  </aside>
  <div class="main">
    <div class="content">
      <div class="article-container">
        <a href="#" class="back-to-top muted-link">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
          </svg>
          <span>Back to top</span>
        </a>
        <div class="content-icon-container">
          <div class="view-this-page">
  <a class="muted-link" href="_sources/reference.rst.txt" title="View this page">
    <svg><use href="#svg-eye"></use></svg>
    <span class="visually-hidden">View this page</span>
  </a>
</div>
<div class="theme-toggle-container theme-toggle-content">
            <button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
            </button>
          </div>
          <label class="toc-overlay-icon toc-content-icon" for="__toc">
            <span class="icon"><svg><use href="#svg-toc"></use></svg></span>
          </label>
        </div>
        <article role="main" id="furo-main-content">
          <section id="module-osxphotos">
<span id="osxphotos-python-reference"></span><h1>OSXPhotos Python Reference<a class="headerlink" href="#module-osxphotos" title="Link to this heading">¶</a></h1>
<p>__init__.py for osxphotos</p>
<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">AlbumInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#AlbumInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.AlbumInfo" title="Link to this definition">¶</a></dt>
<dd><p>Info about a specific Album, contains all the details about the album
including folders, photos, etc.</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#AlbumInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.AlbumInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return album info as a dict; does not include photos</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.folder_list">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_list</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.folder_list" title="Link to this definition">¶</a></dt>
<dd><p>Returns list of FolderInfo objects for each folder the album is contained in
or empty list if album is not in any folders</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.folder_names">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_names</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.folder_names" title="Link to this definition">¶</a></dt>
<dd><p>Return hierarchical list of folders the album is contained in
the folder list is in form:
[&quot;Top level folder&quot;, &quot;sub folder 1&quot;, &quot;sub folder 2&quot;, ...]
or empty list if album is not in any folders</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.parent">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.parent" title="Link to this definition">¶</a></dt>
<dd><p>returns FolderInfo object for parent folder or None if no parent (e.g. top-level album)</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.photo_index">
<span class="sig-name descname"><span class="pre">photo_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#AlbumInfo.photo_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.AlbumInfo.photo_index" title="Link to this definition">¶</a></dt>
<dd><p>return index of photo in album (based on album sort order)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.photos">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.photos" title="Link to this definition">¶</a></dt>
<dd><p>return list of photos contained in album sorted in same sort order as Photos</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.sort_order">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sort_order</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.sort_order" title="Link to this definition">¶</a></dt>
<dd><p>return sort order of album</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.AlbumInfo.title">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.AlbumInfo.title" title="Link to this definition">¶</a></dt>
<dd><p>return title / name of album</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.AlbumSortOrder">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">AlbumSortOrder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/_constants.html#AlbumSortOrder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.AlbumSortOrder" title="Link to this definition">¶</a></dt>
<dd><p>Album Sort Order</p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.CommentInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">CommentInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ismine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">text</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/commentinfo.html#CommentInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.CommentInfo" title="Link to this definition">¶</a></dt>
<dd><p>Class for shared photo comments</p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ExifInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExifInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flash_fired</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">iso</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metering_mode</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sample_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">track_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">white_balance</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aperture</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bit_rate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">duration</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exposure_bias</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">focal_length</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fps</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">latitude</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">longitude</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shutter_speed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera_make</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">camera_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">codec</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lens_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tzoffset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tzname</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exifinfo.html#ExifInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifInfo" title="Link to this definition">¶</a></dt>
<dd><p>Original EXIF info associated with a photo from the Photos library</p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ExifTool">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExifTool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">large_file_support</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool" title="Link to this definition">¶</a></dt>
<dd><p>Basic exiftool interface for reading and writing EXIF tags</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExifTool.addvalues">
<span class="sig-name descname"><span class="pre">addvalues</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool.addvalues"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.addvalues" title="Link to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>Add one or more value(s) to tag</dt><dd><p>If more than one value is passed, each value will be added to the tag</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tag</strong> -- str; tag to set</p></li>
<li><p><strong>*values</strong> -- str; one or more values to set</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><p>True if success otherwise False</p>
<p>If error generated by exiftool, returns False and sets self.error to error string
If warning generated by exiftool, returns True (unless there was also an error) and sets self.warning to warning string
If called in context manager, returns True (execution is delayed until exiting context manager)</p>
</p>
</dd>
</dl>
<dl class="simple">
<dt>Notes: exiftool may add duplicate values for some tags so the caller must ensure</dt><dd><p>the values being added are not already in the EXIF data
For some tags, such as IPTC:Keywords, this will add a new value to the list of keywords,
but for others, such as EXIF:ISO, this will literally add a value to the existing value.
It's up to the caller to know what exiftool will do for each tag
If setvalue called before addvalues, exiftool does not appear to add duplicates,
but if addvalues called without first calling setvalue, exiftool will add duplicate values</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExifTool.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag_groups</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalized</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.asdict" title="Link to this definition">¶</a></dt>
<dd><p>return dictionary of all EXIF tags and values from exiftool
returns empty dict if no tags</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tag_groups</strong> -- if True (default), dict keys have tag groups, e.g. &quot;IPTC:Keywords&quot;; if False, drops groups from keys, e.g. &quot;Keywords&quot;</p></li>
<li><p><strong>normalized</strong> -- if True, dict keys are all normalized to lower case (default is False)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExifTool.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.json" title="Link to this definition">¶</a></dt>
<dd><p>returns JSON string containing all EXIF tags and values from exiftool</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ExifTool.pid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pid</span></span><a class="headerlink" href="#osxphotos.ExifTool.pid" title="Link to this definition">¶</a></dt>
<dd><p>return process id (PID) of the exiftool process</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExifTool.run_commands">
<span class="sig-name descname"><span class="pre">run_commands</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">commands</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool.run_commands"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.run_commands" title="Link to this definition">¶</a></dt>
<dd><p>Run commands in the exiftool process and return result.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>*commands</strong> -- exiftool commands to run</p></li>
<li><p><strong>no_file</strong> -- (bool) do not pass the filename to exiftool (default=False)
by default, all commands will be run against self.file
use no_file=True to run a command without passing the filename</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>(output, warning, error)
output: bytes is containing output of exiftool commands
warning: if exiftool generated warnings, string containing warning otherwise empty string
error: if exiftool generated errors, string containing otherwise empty string</p>
</dd>
</dl>
<p>Note: Also sets self.warning and self.error if warning or error generated.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExifTool.setvalue">
<span class="sig-name descname"><span class="pre">setvalue</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exiftool.html#ExifTool.setvalue"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifTool.setvalue" title="Link to this definition">¶</a></dt>
<dd><p>Set tag to value(s); if value is None, will delete tag</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>tag</strong> -- str; name of tag to set</p></li>
<li><p><strong>value</strong> -- Any; value to set tag to</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><p>True if success otherwise False</p>
<p>If error generated by exiftool, returns False and sets self.error to error string
If warning generated by exiftool, returns True (unless there was also an error) and sets self.warning to warning string
If called in context manager, returns True (execution is delayed until exiting context manager)</p>
</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ExifTool.version">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">version</span></span><a class="headerlink" href="#osxphotos.ExifTool.version" title="Link to this definition">¶</a></dt>
<dd><p>returns exiftool version</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ExifWriter">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExifWriter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.PhotoInfo"><span class="pre">PhotoInfo</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exifwriter.html#ExifWriter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifWriter" title="Link to this definition">¶</a></dt>
<dd><p>Write EXIF &amp; other metadata to files using exiftool for a Photo asset</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>photo</strong> -- PhotoInfo, the photo object to write metadata for</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExifWriter.exiftool_dict">
<span class="sig-name descname"><span class="pre">exiftool_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ExifOptions</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exifwriter.html#ExifWriter.exiftool_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifWriter.exiftool_dict" title="Link to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>Return dict of EXIF details for building exiftool JSON sidecar or sending commands to ExifTool.</dt><dd><p>Does not include all the EXIF fields as those are likely already in the image.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>options</strong> (<em>ExifOptions</em>) -- options for export</p></li>
<li><p><strong>filename</strong> (<em>str</em>) -- name of source image file (without path); if not None, exiftool JSON signature will be included; if None, signature will not be included</p></li>
</ul>
</dd>
</dl>
<p>Returns: dict with exiftool tags / values</p>
<dl class="simple">
<dt>Exports the following:</dt><dd><p>EXIF:ImageDescription (may include template)
XMP:Description (may include template)
XMP:Title
IPTC:ObjectName
XMP:TagsList (may include album name, person name, or template)
IPTC:Keywords (may include album name, person name, or template)
IPTC:Caption-Abstract
XMP:Subject (set to keywords + persons)
XMP:PersonInImage
EXIF:GPSLatitudeRef, EXIF:GPSLongitudeRef
EXIF:GPSLatitude, EXIF:GPSLongitude
EXIF:GPSPosition
EXIF:DateTimeOriginal
EXIF:SubSecTimeOriginal
EXIF:OffsetTimeOriginal (UTC offset for DateTimeOriginal)
EXIF:ModifyDate
EXIF:SubSecTime
EXIF:OffsetTime (UTC offset for ModifyDate)
IPTC:DateCreated
IPTC:TimeCreated
QuickTime:CreationDate
QuickTime:ContentCreateDate
QuickTime:CreateDate (UTC)
QuickTime:ModifyDate (UTC)
QuickTime:GPSCoordinates
UserData:GPSCoordinates
XMP:Rating
XMP:RegionAppliedToDimensionsW
XMP:RegionAppliedToDimensionsH
XMP:RegionAppliedToDimensionsUnit
XMP:RegionName
XMP:RegionType
XMP:RegionAreaX
XMP:RegionAreaY
XMP:RegionAreaW
XMP:RegionAreaH
XMP:RegionAreaUnit
XMP:RegionPersonDisplayName</p>
</dd>
<dt>Reference:</dt><dd><p><a class="reference external" href="https://iptc.org/std/photometadata/specification/IPTC-PhotoMetadata-201610_1.pdf">https://iptc.org/std/photometadata/specification/IPTC-PhotoMetadata-201610_1.pdf</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExifWriter.exiftool_json_sidecar">
<span class="sig-name descname"><span class="pre">exiftool_json_sidecar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ExifOptions</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag_groups</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/osxphotos/exifwriter.html#ExifWriter.exiftool_json_sidecar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifWriter.exiftool_json_sidecar" title="Link to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>Return JSON string of EXIF details for building exiftool JSON sidecar or sending commands to ExifTool.</dt><dd><p>Does not include all the EXIF fields as those are likely already in the image.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>options</strong> (<em>ExifOptions</em>) -- options for export</p></li>
<li><p><strong>tag_groups</strong> (<em>bool</em><em>, </em><em>default=True</em>) -- if True, include tag groups in the output</p></li>
<li><p><strong>filename</strong> (<em>str</em>) -- name of target image file (without path); if not None, exiftool JSON signature will be included; if None, signature will not be included</p></li>
</ul>
</dd>
</dl>
<p>Returns: JSON string for dict with exiftool tags / values</p>
<dl class="simple">
<dt>Exports the following:</dt><dd><p>EXIF:ImageDescription (may include template)
XMP:Description (may include template)
XMP:Title
IPTC:ObjectName
XMP:TagsList (may include album name, person name, or template)
IPTC:Keywords (may include album name, person name, or template)
IPTC:Caption-Abstract
XMP:Subject (set to keywords + persons)
XMP:PersonInImage
EXIF:GPSLatitudeRef, EXIF:GPSLongitudeRef
EXIF:GPSLatitude, EXIF:GPSLongitude
EXIF:GPSPosition
EXIF:DateTimeOriginal
EXIF:SubSecTimeOriginal
EXIF:OffsetTimeOriginal (UTC offset for DateTimeOriginal)
EXIF:ModifyDate
EXIF:SubSecTime
EXIF:OffsetTime (UTC offset for ModifyDate)
IPTC:DateCreated
IPTC:TimeCreated
QuickTime:CreationDate
QuickTime:ContentCreateDate
QuickTime:CreateDate (UTC)
QuickTime:ModifyDate (UTC)
QuickTime:GPSCoordinates
UserData:GPSCoordinates
XMP:Rating
XMP:RegionAppliedToDimensionsW
XMP:RegionAppliedToDimensionsH
XMP:RegionAppliedToDimensionsUnit
XMP:RegionName
XMP:RegionType
XMP:RegionAreaX
XMP:RegionAreaY
XMP:RegionAreaW
XMP:RegionAreaH
XMP:RegionAreaUnit
XMP:RegionPersonDisplayName</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExifWriter.write_exif_data">
<span class="sig-name descname"><span class="pre">write_exif_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ExifOptions</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exifwriter.html#ExifWriter.write_exif_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExifWriter.write_exif_data" title="Link to this definition">¶</a></dt>
<dd><p>Write exif data to image file at filepath</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>options</strong> (<em>ExifOptions</em>) -- options controlling what data is written</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>(warning, error) of warning and error strings if exiftool produces warnings or errors</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ExportDB">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExportDB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbfile</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB" title="Link to this definition">¶</a></dt>
<dd><p>Interface to sqlite3 database used to store state information for osxphotos export command</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dbfile</strong> -- path to osxphotos export database file</p></li>
<li><p><strong>export_dir</strong> -- path to directory where exported files are stored; if None will read value from database</p></li>
<li><p><strong>version</strong> -- if supplied, creates database with this version; otherwise uses current version;
(must be &gt;= &quot;4.3&quot; and &lt;= OSXPHOTOS_EXPORTDB_VERSION)
For testing only; in normal usage, omit this argument</p></li>
</ul>
</dd>
</dl>
<p>Note: export_dir = None must only be used when opening an existing database to read and not to export</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.close">
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.close"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.close" title="Link to this definition">¶</a></dt>
<dd><p>close the database connection</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ExportDB.connection">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">connection</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Connection</span></em><a class="headerlink" href="#osxphotos.ExportDB.connection" title="Link to this definition">¶</a></dt>
<dd><p>returns sqlite3 connection</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.create_file_record">
<span class="sig-name descname"><span class="pre">create_file_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExportRecord</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.create_file_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.create_file_record" title="Link to this definition">¶</a></dt>
<dd><p>create a new record for filename and uuid</p>
<p>Returns: an ExportRecord object</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.create_or_get_file_record">
<span class="sig-name descname"><span class="pre">create_or_get_file_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ExportRecord</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.create_or_get_file_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.create_or_get_file_record" title="Link to this definition">¶</a></dt>
<dd><p>create a new record for filename and uuid or return existing record</p>
<p>Returns: an ExportRecord object</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.delete_data_for_filepath">
<span class="sig-name descname"><span class="pre">delete_data_for_filepath</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.delete_data_for_filepath"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.delete_data_for_filepath" title="Link to this definition">¶</a></dt>
<dd><p>Delete all exportdb data for given filepath</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.delete_data_for_uuid">
<span class="sig-name descname"><span class="pre">delete_data_for_uuid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.delete_data_for_uuid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.delete_data_for_uuid" title="Link to this definition">¶</a></dt>
<dd><p>Delete all exportdb data for given UUID</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ExportDB.export_dir">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">export_dir</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.ExportDB.export_dir" title="Link to this definition">¶</a></dt>
<dd><p>returns path to export directory</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_export_results">
<span class="sig-name descname"><span class="pre">get_export_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">run</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="s"><span class="pre">'osxphotos.photoexporter.ExportResults'</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_export_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_export_results" title="Link to this definition">¶</a></dt>
<dd><p>Retrieve export results from database</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>run</strong> (<em>-1 = previous</em>) -- which run to retrieve results for;</p></li>
<li><p><strong>run</strong></p></li>
<li><p><strong>run</strong></p></li>
<li><p><strong>that</strong> (<em>-2 = run prior to</em>)</p></li>
<li><p><strong>etc.</strong></p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>ExportResults object or None if no results found</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_exported_files">
<span class="sig-name descname"><span class="pre">get_exported_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_exported_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_exported_files" title="Link to this definition">¶</a></dt>
<dd><p>Returns tuple of (uuid, filepath) for all paths of all exported files tracked in the database</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_file_record">
<span class="sig-name descname"><span class="pre">get_file_record</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">os.PathLike</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="s"><span class="pre">'ExportRecord'</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_file_record"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_file_record" title="Link to this definition">¶</a></dt>
<dd><p>get info for filename</p>
<p>Returns: an ExportRecord object or None if filename not found</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_files_for_uuid">
<span class="sig-name descname"><span class="pre">get_files_for_uuid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_files_for_uuid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_files_for_uuid" title="Link to this definition">¶</a></dt>
<dd><p>query database for UUID and return list of files associated with UUID or empty list</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_history">
<span class="sig-name descname"><span class="pre">get_history</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filepath</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_history"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_history" title="Link to this definition">¶</a></dt>
<dd><p>Get history for a filepath or uuid</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filepath</strong> -- path to file</p></li>
<li><p><strong>uuid</strong> -- UUID of file</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of history records</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_last_export_directory">
<span class="sig-name descname"><span class="pre">get_last_export_directory</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_last_export_directory"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_last_export_directory" title="Link to this definition">¶</a></dt>
<dd><p>Return the last export directory from the database</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_photoinfo_for_uuid">
<span class="sig-name descname"><span class="pre">get_photoinfo_for_uuid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_photoinfo_for_uuid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_photoinfo_for_uuid" title="Link to this definition">¶</a></dt>
<dd><p>returns the photoinfo JSON string for a UUID or None if not found</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_previous_uuids">
<span class="sig-name descname"><span class="pre">get_previous_uuids</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_previous_uuids"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_previous_uuids" title="Link to this definition">¶</a></dt>
<dd><p>returns list of UUIDs of previously exported photos found in export database</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_target_for_file">
<span class="sig-name descname"><span class="pre">get_target_for_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_target_for_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_target_for_file" title="Link to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>query database for file matching file name and return the matching filename if there is one;</dt><dd><p>otherwise return None; looks for file.ext, file (1).ext, file (2).ext and so on to find the
actual target name that was used to export filename</p>
</dd>
</dl>
<p>Returns: the matching filename or None if no match found</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.get_uuid_for_file">
<span class="sig-name descname"><span class="pre">get_uuid_for_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.get_uuid_for_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.get_uuid_for_file" title="Link to this definition">¶</a></dt>
<dd><p>query database for filename and return UUID
returns None if filename not found in database</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ExportDB.path">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.ExportDB.path" title="Link to this definition">¶</a></dt>
<dd><p>returns path to export database</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.set_config">
<span class="sig-name descname"><span class="pre">set_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">config_data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.set_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.set_config" title="Link to this definition">¶</a></dt>
<dd><p>set config in the database</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.set_export_results">
<span class="sig-name descname"><span class="pre">set_export_results</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">results</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportResults" title="osxphotos.exportoptions.ExportResults"><span class="pre">ExportResults</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.set_export_results"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.set_export_results" title="Link to this definition">¶</a></dt>
<dd><p>Store export results in database; data is pickled and gzipped for storage</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.set_history">
<span class="sig-name descname"><span class="pre">set_history</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PathLike</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">action</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">diff</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.set_history"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.set_history" title="Link to this definition">¶</a></dt>
<dd><p>Set the history record for the filepath</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>filename</strong> -- path to file</p></li>
<li><p><strong>action</strong> -- action taken on file, e.g. &quot;exported&quot;, &quot;skipped&quot;, &quot;missing&quot;, &quot;updated&quot;</p></li>
<li><p><strong>diff</strong> -- diff for file as a serialized JSON str</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportDB.set_photoinfo_for_uuid">
<span class="sig-name descname"><span class="pre">set_photoinfo_for_uuid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDB.set_photoinfo_for_uuid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDB.set_photoinfo_for_uuid" title="Link to this definition">¶</a></dt>
<dd><p>sets the photoinfo JSON string for a UUID</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ExportDBTemp">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExportDBTemp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">version</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/export_db.html#ExportDBTemp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportDBTemp" title="Link to this definition">¶</a></dt>
<dd><p>Temporary in-memory version of ExportDB</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>version</strong> -- if supplied, creates database with this version; otherwise uses current version;
(must be &gt;= &quot;4.3&quot; and &lt;= OSXPHOTOS_EXPORTDB_VERSION)
For testing only; in normal usage, omit this argument</p>
</dd>
</dl>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ExportOptions">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExportOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">convert_to_jpeg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">download_missing</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dry_run</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edited</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool_flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_as_hardlink</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportDB" title="osxphotos.export_db.ExportDB"><span class="pre">ExportDB</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">face_regions</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fileutil</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.FileUtil" title="osxphotos.fileutil.FileUtil"><span class="pre">FileUtil</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_date_modified</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_signature</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">increment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jpeg_ext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">jpeg_quality</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">1.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keyword_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live_photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_exif_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">merge_exif_persons</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persons</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preview_suffix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'_preview'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preview</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">render_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RenderOptions</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">replace_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rich</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_aae</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_drop_ext</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">strip</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">120</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">touch_file</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_errors</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_albums_as_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_persons_as_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_photokit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_photos_export</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tmpdir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">favorite_rating</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fix_orientation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exportoptions.html#ExportOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportOptions" title="Link to this definition">¶</a></dt>
<dd><p>Options class for exporting photos with export</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.convert_to_jpeg">
<span class="sig-name descname"><span class="pre">convert_to_jpeg</span></span><a class="headerlink" href="#osxphotos.ExportOptions.convert_to_jpeg" title="Link to this definition">¶</a></dt>
<dd><p>if True, converts non-jpeg images to jpeg</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.description_template">
<span class="sig-name descname"><span class="pre">description_template</span></span><a class="headerlink" href="#osxphotos.ExportOptions.description_template" title="Link to this definition">¶</a></dt>
<dd><p>Optional template string that will be rendered for use as photo description</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.download_missing">
<span class="sig-name descname"><span class="pre">download_missing</span></span><a class="headerlink" href="#osxphotos.ExportOptions.download_missing" title="Link to this definition">¶</a></dt>
<dd><p>(bool, default=False): if True will attempt to export photo via applescript interaction with Photos if missing (see also use_photokit, use_photos_export)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.dry_run">
<span class="sig-name descname"><span class="pre">dry_run</span></span><a class="headerlink" href="#osxphotos.ExportOptions.dry_run" title="Link to this definition">¶</a></dt>
<dd><p>(bool, default=False): set to True to run in &quot;dry run&quot; mode</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.edited">
<span class="sig-name descname"><span class="pre">edited</span></span><a class="headerlink" href="#osxphotos.ExportOptions.edited" title="Link to this definition">¶</a></dt>
<dd><p>(bool, default=False): if True will export the edited version of the photo otherwise exports the original version</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.exiftool_flags">
<span class="sig-name descname"><span class="pre">exiftool_flags</span></span><a class="headerlink" href="#osxphotos.ExportOptions.exiftool_flags" title="Link to this definition">¶</a></dt>
<dd><p>Optional list of flags to pass to exiftool when using exiftool option, e.g [&quot;-m&quot;, &quot;-F&quot;]</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of str</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.exiftool_path">
<span class="sig-name descname"><span class="pre">exiftool_path</span></span><a class="headerlink" href="#osxphotos.ExportOptions.exiftool_path" title="Link to this definition">¶</a></dt>
<dd><p>path to exiftool executable</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.exiftool">
<span class="sig-name descname"><span class="pre">exiftool</span></span><a class="headerlink" href="#osxphotos.ExportOptions.exiftool" title="Link to this definition">¶</a></dt>
<dd><p>(bool, default = False): if True, will use exiftool to write metadata to export file</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.export_as_hardlink">
<span class="sig-name descname"><span class="pre">export_as_hardlink</span></span><a class="headerlink" href="#osxphotos.ExportOptions.export_as_hardlink" title="Link to this definition">¶</a></dt>
<dd><p>(bool, default=False): if True, will hardlink files instead of copying them</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.export_db">
<span class="sig-name descname"><span class="pre">export_db</span></span><a class="headerlink" href="#osxphotos.ExportOptions.export_db" title="Link to this definition">¶</a></dt>
<dd><p>(ExportDB): instance of a class that conforms to ExportDB with methods for getting/setting data related to exported files to compare update state</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#osxphotos.ExportDB" title="osxphotos.export_db.ExportDB">osxphotos.export_db.ExportDB</a> | None</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.face_regions">
<span class="sig-name descname"><span class="pre">face_regions</span></span><a class="headerlink" href="#osxphotos.ExportOptions.face_regions" title="Link to this definition">¶</a></dt>
<dd><p>(bool, default=True): if True, will export face regions</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.fileutil">
<span class="sig-name descname"><span class="pre">fileutil</span></span><a class="headerlink" href="#osxphotos.ExportOptions.fileutil" title="Link to this definition">¶</a></dt>
<dd><p>(FileUtilABC): class that conforms to FileUtilABC with various file utilities</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#osxphotos.FileUtil" title="osxphotos.fileutil.FileUtil">osxphotos.fileutil.FileUtil</a> | None</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.force_update">
<span class="sig-name descname"><span class="pre">force_update</span></span><a class="headerlink" href="#osxphotos.ExportOptions.force_update" title="Link to this definition">¶</a></dt>
<dd><p>(bool, default=False): if True, will export photo if any metadata has changed but export otherwise would not be triggered (e.g. metadata changed but not using exiftool)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.ignore_date_modified">
<span class="sig-name descname"><span class="pre">ignore_date_modified</span></span><a class="headerlink" href="#osxphotos.ExportOptions.ignore_date_modified" title="Link to this definition">¶</a></dt>
<dd><p>for use with sidecar and exiftool; if True, sets EXIF:ModifyDate to EXIF:DateTimeOriginal even if date_modified is set</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.ignore_signature">
<span class="sig-name descname"><span class="pre">ignore_signature</span></span><a class="headerlink" href="#osxphotos.ExportOptions.ignore_signature" title="Link to this definition">¶</a></dt>
<dd><p>ignore file signature when used with update (look only at filename)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.increment">
<span class="sig-name descname"><span class="pre">increment</span></span><a class="headerlink" href="#osxphotos.ExportOptions.increment" title="Link to this definition">¶</a></dt>
<dd><p>if True, will increment file name until a non-existant name is found if overwrite=False and increment=False, export will fail if destination file already exists</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=True</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.jpeg_ext">
<span class="sig-name descname"><span class="pre">jpeg_ext</span></span><a class="headerlink" href="#osxphotos.ExportOptions.jpeg_ext" title="Link to this definition">¶</a></dt>
<dd><p>if set, will use this value for extension on jpegs converted to jpeg with convert_to_jpeg; if not set, uses jpeg; do not include the leading &quot;.&quot;</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.jpeg_quality">
<span class="sig-name descname"><span class="pre">jpeg_quality</span></span><a class="headerlink" href="#osxphotos.ExportOptions.jpeg_quality" title="Link to this definition">¶</a></dt>
<dd><p>a value of 1.0 specifies use best quality, a value of 0.0 specifies use maximum compression.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>float in range 0.0 &lt;= jpeg_quality &lt;= 1.0</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.keyword_template">
<span class="sig-name descname"><span class="pre">keyword_template</span></span><a class="headerlink" href="#osxphotos.ExportOptions.keyword_template" title="Link to this definition">¶</a></dt>
<dd><p>list of template strings that will be rendered as used as keywords</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of str</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.live_photo">
<span class="sig-name descname"><span class="pre">live_photo</span></span><a class="headerlink" href="#osxphotos.ExportOptions.live_photo" title="Link to this definition">¶</a></dt>
<dd><p>if True, will also export the associated .mov for live photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.location">
<span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#osxphotos.ExportOptions.location" title="Link to this definition">¶</a></dt>
<dd><p>if True, include location in exported metadata</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.merge_exif_keywords">
<span class="sig-name descname"><span class="pre">merge_exif_keywords</span></span><a class="headerlink" href="#osxphotos.ExportOptions.merge_exif_keywords" title="Link to this definition">¶</a></dt>
<dd><p>if True, merged keywords found in file's exif data (requires exiftool)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.merge_exif_persons">
<span class="sig-name descname"><span class="pre">merge_exif_persons</span></span><a class="headerlink" href="#osxphotos.ExportOptions.merge_exif_persons" title="Link to this definition">¶</a></dt>
<dd><p>if True, merged persons found in file's exif data (requires exiftool)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.overwrite">
<span class="sig-name descname"><span class="pre">overwrite</span></span><a class="headerlink" href="#osxphotos.ExportOptions.overwrite" title="Link to this definition">¶</a></dt>
<dd><p>if True will overwrite files if they already exist</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.persons">
<span class="sig-name descname"><span class="pre">persons</span></span><a class="headerlink" href="#osxphotos.ExportOptions.persons" title="Link to this definition">¶</a></dt>
<dd><p>if True, include persons in exported metadata</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.preview_suffix">
<span class="sig-name descname"><span class="pre">preview_suffix</span></span><a class="headerlink" href="#osxphotos.ExportOptions.preview_suffix" title="Link to this definition">¶</a></dt>
<dd><p>Optional string to append to end of filename for preview images</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.preview">
<span class="sig-name descname"><span class="pre">preview</span></span><a class="headerlink" href="#osxphotos.ExportOptions.preview" title="Link to this definition">¶</a></dt>
<dd><p>if True, also exports preview image</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.raw_photo">
<span class="sig-name descname"><span class="pre">raw_photo</span></span><a class="headerlink" href="#osxphotos.ExportOptions.raw_photo" title="Link to this definition">¶</a></dt>
<dd><p>if True, will also export the associated RAW photo</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.render_options">
<span class="sig-name descname"><span class="pre">render_options</span></span><a class="headerlink" href="#osxphotos.ExportOptions.render_options" title="Link to this definition">¶</a></dt>
<dd><p>Optional osxphotos.phototemplate.RenderOptions instance to specify options for rendering templates</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>RenderOptions</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.replace_keywords">
<span class="sig-name descname"><span class="pre">replace_keywords</span></span><a class="headerlink" href="#osxphotos.ExportOptions.replace_keywords" title="Link to this definition">¶</a></dt>
<dd><p>if True, keyword_template replaces any keywords, otherwise it's additive</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.rich">
<span class="sig-name descname"><span class="pre">rich</span></span><a class="headerlink" href="#osxphotos.ExportOptions.rich" title="Link to this definition">¶</a></dt>
<dd><p>if True, will use rich markup with verbose output</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.export_aae">
<span class="sig-name descname"><span class="pre">export_aae</span></span><a class="headerlink" href="#osxphotos.ExportOptions.export_aae" title="Link to this definition">¶</a></dt>
<dd><p>if True, also exports adjustments as .AAE file</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.sidecar_drop_ext">
<span class="sig-name descname"><span class="pre">sidecar_drop_ext</span></span><a class="headerlink" href="#osxphotos.ExportOptions.sidecar_drop_ext" title="Link to this definition">¶</a></dt>
<dd><p>if True, drops the photo's extension from sidecar filename (e.g. 'IMG_1234.json' instead of 'IMG_1234.JPG.json')</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.sidecar">
<span class="sig-name descname"><span class="pre">sidecar</span></span><a class="headerlink" href="#osxphotos.ExportOptions.sidecar" title="Link to this definition">¶</a></dt>
<dd><p>bit field (int): set to one or more of 'SIDECAR_XMP', 'SIDECAR_JSON', 'SIDECAR_EXIFTOOL'
- SIDECAR_JSON: if set will write a json sidecar with data in format readable by exiftool sidecar filename will be dest/filename.json;
includes exiftool tag group names (e.g. 'exiftool -G -j')
- SIDECAR_EXIFTOOL: if set will write a json sidecar with data in format readable by exiftool sidecar filename will be dest/filename.json;
does not include exiftool tag group names (e.g. 'exiftool -j')
- SIDECAR_XMP: if set will write an XMP sidecar with IPTC data sidecar filename will be dest/filename.xmp</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.strip">
<span class="sig-name descname"><span class="pre">strip</span></span><a class="headerlink" href="#osxphotos.ExportOptions.strip" title="Link to this definition">¶</a></dt>
<dd><p>if True, strip whitespace from rendered templates</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.timeout">
<span class="sig-name descname"><span class="pre">timeout</span></span><a class="headerlink" href="#osxphotos.ExportOptions.timeout" title="Link to this definition">¶</a></dt>
<dd><p>timeout in seconds used with use_photos_export</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int, default=120</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.touch_file">
<span class="sig-name descname"><span class="pre">touch_file</span></span><a class="headerlink" href="#osxphotos.ExportOptions.touch_file" title="Link to this definition">¶</a></dt>
<dd><p>if True, sets file's modification time upon photo date</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.update">
<span class="sig-name descname"><span class="pre">update</span></span><a class="headerlink" href="#osxphotos.ExportOptions.update" title="Link to this definition">¶</a></dt>
<dd><p>if True export will run in update mode, that is, it will not export the photo if the current version already exists in the destination</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.update_errors">
<span class="sig-name descname"><span class="pre">update_errors</span></span><a class="headerlink" href="#osxphotos.ExportOptions.update_errors" title="Link to this definition">¶</a></dt>
<dd><p>if True photos that previously produced a warning or error will be re-exported; otherwise they will note be</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.use_albums_as_keywords">
<span class="sig-name descname"><span class="pre">use_albums_as_keywords</span></span><a class="headerlink" href="#osxphotos.ExportOptions.use_albums_as_keywords" title="Link to this definition">¶</a></dt>
<dd><p>if True, will include album names in keywords when exporting metadata with exiftool or sidecar</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default = False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.use_persons_as_keywords">
<span class="sig-name descname"><span class="pre">use_persons_as_keywords</span></span><a class="headerlink" href="#osxphotos.ExportOptions.use_persons_as_keywords" title="Link to this definition">¶</a></dt>
<dd><p>if True, will include person names in keywords when exporting metadata with exiftool or sidecar</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default = False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.use_photos_export">
<span class="sig-name descname"><span class="pre">use_photos_export</span></span><a class="headerlink" href="#osxphotos.ExportOptions.use_photos_export" title="Link to this definition">¶</a></dt>
<dd><p>if True will attempt to export photo via applescript interaction with Photos even if not missing (see also use_photokit, download_missing)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.use_photokit">
<span class="sig-name descname"><span class="pre">use_photokit</span></span><a class="headerlink" href="#osxphotos.ExportOptions.use_photokit" title="Link to this definition">¶</a></dt>
<dd><p>if True, will use photokit to export photos when use_photos_export is True</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool, default=False</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.verbose">
<span class="sig-name descname"><span class="pre">verbose</span></span><a class="headerlink" href="#osxphotos.ExportOptions.verbose" title="Link to this definition">¶</a></dt>
<dd><p>optional callable function to use for printing verbose text during processing; if None (default), does not print output.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>callable</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.tmpdir">
<span class="sig-name descname"><span class="pre">tmpdir</span></span><a class="headerlink" href="#osxphotos.ExportOptions.tmpdir" title="Link to this definition">¶</a></dt>
<dd><p>(str, default=None): Optional directory to use for temporary files, if None (default) uses system tmp directory</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str | None</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.favorite_rating">
<span class="sig-name descname"><span class="pre">favorite_rating</span></span><a class="headerlink" href="#osxphotos.ExportOptions.favorite_rating" title="Link to this definition">¶</a></dt>
<dd><p>if True, set XMP:Rating=5 for favorite images and XMP:Rating=0 for non-favorites</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.fix_orientation">
<span class="sig-name descname"><span class="pre">fix_orientation</span></span><a class="headerlink" href="#osxphotos.ExportOptions.fix_orientation" title="Link to this definition">¶</a></dt>
<dd><p>if True, will adjust image orientation based on exif data if necessary</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.sidecar_template">
<span class="sig-name descname"><span class="pre">sidecar_template</span></span><a class="headerlink" href="#osxphotos.ExportOptions.sidecar_template" title="Link to this definition">¶</a></dt>
<dd><p>tuple of (template_file, filename_template, options) for user sidecar templates; multiple templates may be specified</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple of tuples</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ExportOptions.bit_flags">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bit_flags</span></span><a class="headerlink" href="#osxphotos.ExportOptions.bit_flags" title="Link to this definition">¶</a></dt>
<dd><p>Return bit flags representing options that affect export</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ExportResults">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ExportResults</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">converted_to_jpeg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted_directories</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted_files</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exif_updated</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool_error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool_warning</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exported</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exported_album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">metadata_changed</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missing</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missing_album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aae_written</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">aae_skipped</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_exiftool_skipped</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_exiftool_written</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_json_skipped</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_json_written</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_xmp_skipped</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_xmp_written</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_user_written</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_user_skipped</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_user_error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipped</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipped_album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_touch</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">touched</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">updated</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xattr_skipped</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xattr_written</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_written</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_skipped</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user_error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/exportoptions.html#ExportResults"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportResults" title="Link to this definition">¶</a></dt>
<dd><p>Results class which holds export results for export</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>converted_to_jpeg</strong> -- list of files converted to jpeg</p></li>
<li><p><strong>deleted_directories</strong> -- list of directories deleted</p></li>
<li><p><strong>deleted_files</strong> -- list of files deleted</p></li>
<li><p><strong>error</strong> -- list of tuples of (filename, error) for any errors generated during export</p></li>
<li><p><strong>exif_updated</strong> -- list of files where exif data was updated with exiftool</p></li>
<li><p><strong>exiftool_error</strong> -- list of tuples of (filename, error) for any errors generated by exiftool</p></li>
<li><p><strong>exiftool_warning</strong> -- list of tuples of (filename, warning) for any warnings generated by exiftool</p></li>
<li><p><strong>exported</strong> -- list of files exported</p></li>
<li><p><strong>exported_album</strong> -- list of tuples of (file, album) for any files exported to an album</p></li>
<li><p><strong>metadata_changed</strong> -- list of filenames that had metadata changes since last export</p></li>
<li><p><strong>missing</strong> -- list of files that were missing</p></li>
<li><p><strong>missing_album</strong> -- list of tuples of (file, album) for any files that were missing from an album</p></li>
<li><p><strong>new</strong> -- list of files that were new</p></li>
<li><p><strong>aae_written</strong> -- list of files where .AAE file was written</p></li>
<li><p><strong>aae_skipped</strong> -- list of files where .AAE file was written</p></li>
<li><p><strong>sidecar_exiftool_skipped</strong> -- list of files where exiftool sidecar was skipped</p></li>
<li><p><strong>sidecar_exiftool_written</strong> -- list of files where exiftool sidecar was written</p></li>
<li><p><strong>sidecar_json_skipped</strong> -- list of files where json sidecar was skipped</p></li>
<li><p><strong>sidecar_json_written</strong> -- list of files where json sidecar was written</p></li>
<li><p><strong>sidecar_xmp_skipped</strong> -- list of files where xmp sidecar was skipped</p></li>
<li><p><strong>sidecar_xmp_written</strong> -- list of files where xmp sidecar was written</p></li>
<li><p><strong>sidecar_user_written</strong> -- list of files where user sidecar was written</p></li>
<li><p><strong>sidecar_user_skipped</strong> -- list of files where user sidecar was skipped</p></li>
<li><p><strong>sidecar_user_error</strong> -- list of tuples of (filename, error) for any errors generated by user sidecar</p></li>
<li><p><strong>skipped</strong> -- list of files that were skipped</p></li>
<li><p><strong>skipped_album</strong> -- list of tuples of (file, album) for any files that were skipped from an album</p></li>
<li><p><strong>to_touch</strong> -- list of files that were touched</p></li>
<li><p><strong>touched</strong> -- list of files that were touched</p></li>
<li><p><strong>updated</strong> -- list of files that were updated</p></li>
<li><p><strong>xattr_skipped</strong> -- list of files where xattr was skipped</p></li>
<li><p><strong>xattr_written</strong> -- list of files where xattr was written</p></li>
<li><p><strong>user_written</strong> -- list of files written by user post_function</p></li>
<li><p><strong>user_skipped</strong> -- list of files skipped by user post_function</p></li>
<li><p><strong>user_error</strong> -- list of tuples of (filename, error) for any errors generated by user post_function</p></li>
</ul>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>Each attribute is a list of files or None if no files for that attribute.
Error and warning attributes are a list of tuples of (filename, error) where filename is the file that caused the error and error is the error message.
Album attributes are a list of tuples of (file, album) where file is the file exported and album is the album it was exported to.
ExportResults can be added together with the += operator to combine results as the export progresses.</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ExportResults.all_files">
<span class="sig-name descname"><span class="pre">all_files</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/exportoptions.html#ExportResults.all_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ExportResults.all_files" title="Link to this definition">¶</a></dt>
<dd><p>return all filenames contained in results</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ExportResults.attributes">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">attributes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.ExportResults.attributes" title="Link to this definition">¶</a></dt>
<dd><p>Return list of attributes tracked by ExportResults</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ExportResults.datetime">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">datetime</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.ExportResults.datetime" title="Link to this definition">¶</a></dt>
<dd><p>Return datetime when ExportResults was created</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.FaceInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">FaceInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pk</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/personinfo.html#FaceInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FaceInfo" title="Link to this definition">¶</a></dt>
<dd><p>Info about a face in the Photos library</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/personinfo.html#FaceInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FaceInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Returns dict representation of class instance</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.center">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">center</span></span><a class="headerlink" href="#osxphotos.FaceInfo.center" title="Link to this definition">¶</a></dt>
<dd><p>Coordinates, in PIL format, for center of face</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple of coordinates in form (x, y)</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.face_rect">
<span class="sig-name descname"><span class="pre">face_rect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/personinfo.html#FaceInfo.face_rect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FaceInfo.face_rect" title="Link to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>Get face rectangle coordinates for current version of the associated image</dt><dd><p>If image has been edited, rectangle applies to edited version, otherwise original version
Coordinates in format and reference frame used by PIL</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list [(x0, x1), (y0, y1)] of coordinates in reference frame used by PIL</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/personinfo.html#FaceInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FaceInfo.json" title="Link to this definition">¶</a></dt>
<dd><p>Return JSON representation of FaceInfo instance</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.mpri_reg_rect">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mpri_reg_rect</span></span><a class="headerlink" href="#osxphotos.FaceInfo.mpri_reg_rect" title="Link to this definition">¶</a></dt>
<dd><p>Get coordinates for Microsoft Photo Region Rectangle.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>x = x coordinate of top left corner of rectangle
y = y coordinate of top left corner of rectangle
h = height of rectangle
w = width of rectangle</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>MPRI_Reg_Rect named tuple with x, y, h, w where</p>
</dd>
</dl>
<dl class="simple">
<dt>Reference:</dt><dd><p><a class="reference external" href="https://docs.microsoft.com/en-us/windows/win32/wic/-wic-people-tagging">https://docs.microsoft.com/en-us/windows/win32/wic/-wic-people-tagging</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.mwg_rs_area">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mwg_rs_area</span></span><a class="headerlink" href="#osxphotos.FaceInfo.mwg_rs_area" title="Link to this definition">¶</a></dt>
<dd><p>Get coordinates for Metadata Working Group Region Area.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>x = stArea:x
y = stArea:y
h = stArea:h
w = stArea:w</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>MWG_RS_Area named tuple with x, y, h, w where</p>
</dd>
</dl>
<dl class="simple">
<dt>Reference:</dt><dd><p><a class="reference external" href="https://photo.stackexchange.com/questions/106410/how-does-xmp-define-the-face-region">https://photo.stackexchange.com/questions/106410/how-does-xmp-define-the-face-region</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.person_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">person_info</span></span><a class="headerlink" href="#osxphotos.FaceInfo.person_info" title="Link to this definition">¶</a></dt>
<dd><p>PersonInfo instance for person associated with this face</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.photo">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photo</span></span><a class="headerlink" href="#osxphotos.FaceInfo.photo" title="Link to this definition">¶</a></dt>
<dd><p>PhotoInfo instance associated with this face</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.pitch">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pitch</span></span><a class="headerlink" href="#osxphotos.FaceInfo.pitch" title="Link to this definition">¶</a></dt>
<dd><p>Return pitch angle in radians of the face region</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.roll">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">roll</span></span><a class="headerlink" href="#osxphotos.FaceInfo.roll" title="Link to this definition">¶</a></dt>
<dd><p>Return roll angle in radians of the face region</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.roll_pitch_yaw">
<span class="sig-name descname"><span class="pre">roll_pitch_yaw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/personinfo.html#FaceInfo.roll_pitch_yaw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FaceInfo.roll_pitch_yaw" title="Link to this definition">¶</a></dt>
<dd><p>Roll, pitch, yaw of face in radians as tuple</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.size_pixels">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">size_pixels</span></span><a class="headerlink" href="#osxphotos.FaceInfo.size_pixels" title="Link to this definition">¶</a></dt>
<dd><p>Size of face in pixels (centered around center_x, center_y)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>size, in int pixels, of a circle drawn around the center of the face</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FaceInfo.yaw">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">yaw</span></span><a class="headerlink" href="#osxphotos.FaceInfo.yaw" title="Link to this definition">¶</a></dt>
<dd><p>Return yaw angle in radians of the face region</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.FileUtil">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">FileUtil</span></span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtil"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtil" title="Link to this definition">¶</a></dt>
<dd><p>Various file utilities</p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">FileUtilNoOp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp" title="Link to this definition">¶</a></dt>
<dd><p>No-Op implementation of FileUtil for testing / dry-run mode
all methods with exception of tmpdir, cmp, cmp_file_sig and file_cmp are no-op
cmp and cmp_file_sig functions as FileUtil methods do
file_cmp returns mock data</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.convert_to_jpeg">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">convert_to_jpeg</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest_file</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compression_quality</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1.0</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.convert_to_jpeg"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.convert_to_jpeg" title="Link to this definition">¶</a></dt>
<dd><p>converts image file src_file to jpeg format as dest_file</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>src_file</strong> -- image file to convert</p></li>
<li><p><strong>dest_file</strong> -- destination path to write converted file to</p></li>
<li><p><strong>quality</strong> (<em>compression</em>) -- JPEG compression quality in range 0.0 &lt;= compression_quality &lt;= 1.0; default 1.0 (best quality)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>True if success, otherwise False</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.copy">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">copy</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.copy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.copy" title="Link to this definition">¶</a></dt>
<dd><p>Copies a file from src path to dest path using shutil.copy</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>src</strong> -- source path as string; must be a valid file path</p></li>
<li><p><strong>dest</strong> -- destination path as string
dest may be either directory or file; in either case, src file must not exist in dest</p></li>
<li><p><strong>Note</strong> -- src and dest may be either a string or a pathlib.Path object</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>True if copy succeeded</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>OSError if copy fails</strong> -- </p></li>
<li><p><strong>TypeError if either path is None</strong> -- </p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.file_sig">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">file_sig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">file1</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.file_sig"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.file_sig" title="Link to this definition">¶</a></dt>
<dd><p>return os.stat signature for file f1 as tuple of (mode, size, mtime)</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.hardlink">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hardlink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.hardlink"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.hardlink" title="Link to this definition">¶</a></dt>
<dd><p>Hardlinks a file from src path to dest path
src: source path as string
dest: destination path as string
Raises exception if linking fails or either path is None</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.rename">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rename</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.rename"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.rename" title="Link to this definition">¶</a></dt>
<dd><p>Copy src to dest</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>src</strong> -- path to source file</p></li>
<li><p><strong>dest</strong> -- path to destination file</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Name of renamed file (dest)</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.rmdir">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rmdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.rmdir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.rmdir" title="Link to this definition">¶</a></dt>
<dd><p>remove directory filepath; dirpath must be empty</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.tmpdir">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tmpdir</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prefix</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">TemporaryDirectory</span></span></span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.tmpdir"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.tmpdir" title="Link to this definition">¶</a></dt>
<dd><p>Securely creates a temporary directory using the same rules as mkdtemp().
The resulting object can be used as a context manager.
On completion of the context or destruction of the temporary directory object,
the newly created temporary directory and all its contents are removed from the filesystem.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.unlink">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unlink</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.unlink"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.unlink" title="Link to this definition">¶</a></dt>
<dd><p>unlink filepath; if it's pathlib.Path, use Path.unlink, otherwise use os.unlink</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FileUtilNoOp.utime">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">utime</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">times</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/fileutil.html#FileUtilNoOp.utime"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FileUtilNoOp.utime" title="Link to this definition">¶</a></dt>
<dd><p>Set the access and modified time of path.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.FolderInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">FolderInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#FolderInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FolderInfo" title="Link to this definition">¶</a></dt>
<dd><p>Info about a specific folder, contains all the details about the folder
including folders, albums, etc</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FolderInfo.album_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">album_info</span></span><a class="headerlink" href="#osxphotos.FolderInfo.album_info" title="Link to this definition">¶</a></dt>
<dd><p>return list of albums (as AlbumInfo objects) contained in the folder</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.FolderInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#FolderInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.FolderInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return folder info as a dict</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FolderInfo.parent">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#osxphotos.FolderInfo.parent" title="Link to this definition">¶</a></dt>
<dd><p>returns FolderInfo object for parent or None if no parent (e.g. top-level folder)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FolderInfo.subfolders">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subfolders</span></span><a class="headerlink" href="#osxphotos.FolderInfo.subfolders" title="Link to this definition">¶</a></dt>
<dd><p>return list of folders (as FolderInfo objects) contained in the folder</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FolderInfo.title">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.FolderInfo.title" title="Link to this definition">¶</a></dt>
<dd><p>return title / name of folder</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.FolderInfo.uuid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uuid</span></span><a class="headerlink" href="#osxphotos.FolderInfo.uuid" title="Link to this definition">¶</a></dt>
<dd><p>return uuid of folder</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ImportInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ImportInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#ImportInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ImportInfo" title="Link to this definition">¶</a></dt>
<dd><p>Information about import sessions</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ImportInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#ImportInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ImportInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return import info as a dict; does not include photos</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ImportInfo.photos">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.ImportInfo.photos" title="Link to this definition">¶</a></dt>
<dd><p>return list of photos contained in import session</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ImportInfo.title">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.ImportInfo.title" title="Link to this definition">¶</a></dt>
<dd><p>return title / name of import session</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.LikeInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">LikeInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">datetime</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">user</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ismine</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/commentinfo.html#LikeInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.LikeInfo" title="Link to this definition">¶</a></dt>
<dd><p>Class for shared photo likes</p>
</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.MomentInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">MomentInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">moment_pk</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/momentinfo.html#MomentInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.MomentInfo" title="Link to this definition">¶</a></dt>
<dd><p>Info about a photo moment</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/momentinfo.html#MomentInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.MomentInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Returns all moment info as dictionary</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.date">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date</span></span><a class="headerlink" href="#osxphotos.MomentInfo.date" title="Link to this definition">¶</a></dt>
<dd><p>Date of the moment.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.end_date">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">end_date</span></span><a class="headerlink" href="#osxphotos.MomentInfo.end_date" title="Link to this definition">¶</a></dt>
<dd><p>Stop date of the moment.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.location">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#osxphotos.MomentInfo.location" title="Link to this definition">¶</a></dt>
<dd><p>Location of the moment.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.modification_date">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">modification_date</span></span><a class="headerlink" href="#osxphotos.MomentInfo.modification_date" title="Link to this definition">¶</a></dt>
<dd><p>Modification date of the moment.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.photos">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.MomentInfo.photos" title="Link to this definition">¶</a></dt>
<dd><p>All photos in this moment</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.pk">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pk</span></span><a class="headerlink" href="#osxphotos.MomentInfo.pk" title="Link to this definition">¶</a></dt>
<dd><p>Primary key of the moment.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.start_date">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">start_date</span></span><a class="headerlink" href="#osxphotos.MomentInfo.start_date" title="Link to this definition">¶</a></dt>
<dd><p>Start date of the moment.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.subtitle">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subtitle</span></span><a class="headerlink" href="#osxphotos.MomentInfo.subtitle" title="Link to this definition">¶</a></dt>
<dd><p>Subtitle of the moment.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.MomentInfo.title">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.MomentInfo.title" title="Link to this definition">¶</a></dt>
<dd><p>Title of the moment.</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.PersonInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PersonInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.PhotosDB" title="osxphotos.photosdb.photosdb.PhotosDB"><span class="pre">PhotosDB</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">pk</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/personinfo.html#PersonInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PersonInfo" title="Link to this definition">¶</a></dt>
<dd><p>Info about a person in the Photos library</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PersonInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/personinfo.html#PersonInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PersonInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Returns dictionary representation of class instance</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PersonInfo.face_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">face_info</span></span><a class="headerlink" href="#osxphotos.PersonInfo.face_info" title="Link to this definition">¶</a></dt>
<dd><p>Returns a list of FaceInfo objects associated with this person sorted by quality score
Highest quality face is result[0] and lowest quality face is result[n]</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PersonInfo.favorite">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorite</span></span><a class="headerlink" href="#osxphotos.PersonInfo.favorite" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if person is a favorite, False otherwise; Photos 5+ only; returns False on Photos &lt;= 4</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PersonInfo.feature_less">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">feature_less</span></span><a class="reference internal" href="_modules/osxphotos/personinfo.html#PersonInfo.feature_less"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PersonInfo.feature_less" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if person has been marked as &quot;Feature This Person Less&quot; in Photos, False otherwise; Photos 8+ only; returns False on Photos &lt;= 7</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PersonInfo.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/personinfo.html#PersonInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PersonInfo.json" title="Link to this definition">¶</a></dt>
<dd><p>Returns JSON representation of class instance</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PersonInfo.photos">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.PersonInfo.photos" title="Link to this definition">¶</a></dt>
<dd><p>Returns list of PhotoInfo objects associated with this person</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PersonInfo.sort_order">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sort_order</span></span><a class="headerlink" href="#osxphotos.PersonInfo.sort_order" title="Link to this definition">¶</a></dt>
<dd><p>Returns sort order of person; favorite persons are sorted before non-favorite persons&quot;; Photos 5+ only; returns 0 on Photos &lt;= 4</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.PhotoExporter">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotoExporter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.PhotoInfo"><span class="pre">PhotoInfo</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">tmpdir</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">t.Optional</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoexporter.html#PhotoExporter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoExporter" title="Link to this definition">¶</a></dt>
<dd><p>Export a photo</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoExporter.export">
<span class="sig-name descname"><span class="pre">export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportOptions" title="osxphotos.exportoptions.ExportOptions"><span class="pre">ExportOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#osxphotos.ExportResults" title="osxphotos.exportoptions.ExportResults"><span class="pre">ExportResults</span></a></span></span><a class="reference internal" href="_modules/osxphotos/photoexporter.html#PhotoExporter.export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoExporter.export" title="Link to this definition">¶</a></dt>
<dd><p>Export photo</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dest</strong> -- must be valid destination path or exception raised</p></li>
<li><p><strong>filename</strong> -- (optional): name of exported picture; if not provided, will use current filename
<strong>NOTE</strong>: if provided, user must ensure file extension (suffix) is correct.
For example, if photo is .CR2 file, edited image may be .jpeg.
If you provide an extension different than what the actual file is,
will export the photo using the incorrect file extension (unless use_photos_export is true,
in which case export will use the extension provided by Photos upon export.
e.g. to get the extension of the edited photo,
reference PhotoInfo.path_edited</p></li>
<li><p><strong>options</strong> (<em>'ExportOptions'</em>) -- t.Optional ExportOptions instance</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>ExportResults instance</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<dl class="simple">
<dt>To use dry run mode, you must set options.dry_run=True and also pass in memory version of export_db,</dt><dd><p>and no-op fileutil (e.g. 'ExportDBInMemory' and 'FileUtilNoOp') in options.export_db and options.fileutil respectively</p>
</dd>
</dl>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoExporter.write_exiftool_metadata_to_file">
<span class="sig-name descname"><span class="pre">write_exiftool_metadata_to_file</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">src</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportOptions" title="osxphotos.exportoptions.ExportOptions"><span class="pre">ExportOptions</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#osxphotos.ExportResults" title="osxphotos.exportoptions.ExportResults"><span class="pre">ExportResults</span></a></span></span><a class="reference internal" href="_modules/osxphotos/photoexporter.html#PhotoExporter.write_exiftool_metadata_to_file"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoExporter.write_exiftool_metadata_to_file" title="Link to this definition">¶</a></dt>
<dd><p>Write exif metadata to src file using exiftool</p>
<p>Caution: This method modifies <em>src</em>, not <em>dest</em>,
so src must be a copy of the original file if you don't want the source modified;
it also does not write to dest (dest is the intended destination for purposes of
referencing the export database. This allows the exiftool update to be done on the
local machine prior to being copied to the export destination which may be on a
network drive or other slower external storage).</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotoInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.PhotosDB" title="osxphotos.photosdb.photosdb.PhotosDB"><span class="pre">PhotosDB</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">info</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo" title="Link to this definition">¶</a></dt>
<dd><p>Info about a specific photo, contains all the details about the photo
including keywords, persons, albums, uuid, path, etc.</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.adjustment_type">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">adjustment_type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.adjustment_type" title="Link to this definition">¶</a></dt>
<dd><p>Returns adjustment type as int or None if no adjustments</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.adjustments">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">adjustments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">AdjustmentsInfo</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.adjustments" title="Link to this definition">¶</a></dt>
<dd><p>Returns AdjustmentsInfo class for adjustment data or None if no adjustments; Photos 5+ only</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.adjustments_path">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">adjustments_path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Path</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.adjustments_path" title="Link to this definition">¶</a></dt>
<dd><p>Returns path to adjustments file or none if file doesn't exist</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ai_caption">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ai_caption</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.ai_caption"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.ai_caption" title="Link to this definition">¶</a></dt>
<dd><p>Returns AI generated caption for photo or video (Photos 5+)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.album_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">album_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.AlbumInfo" title="osxphotos.albuminfo.AlbumInfo"><span class="pre">AlbumInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.album_info" title="Link to this definition">¶</a></dt>
<dd><p>list of AlbumInfo objects representing albums the photo is contained in</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.albums">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">albums</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.albums" title="Link to this definition">¶</a></dt>
<dd><p>list of albums picture is contained in</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shallow</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return dict representation of PhotoInfo object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>shallow</strong> -- if True, return shallow representation (does not contain folder_info, person_info, etc.)</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>dict representation of PhotoInfo object</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The shallow representation is used internally by export as it contains only the subset of data needed for export.</p>
</div>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.burst" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is part of a Burst photo set, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_album_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_album_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.AlbumInfo" title="osxphotos.albuminfo.AlbumInfo"><span class="pre">AlbumInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.burst_album_info" title="Link to this definition">¶</a></dt>
<dd><p>If photo is a burst photo, returns list of AlbumInfo objects representing albums the photo is contained in as well as albums the burst key photo is contained in, otherwise returns self.album_info.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_albums">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_albums</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.burst_albums" title="Link to this definition">¶</a></dt>
<dd><p>If photo is burst photo, list of albums it is contained in as well as any albums the key photo is contained in, otherwise returns self.albums</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_default_pick">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_default_pick</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.burst_default_pick" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a burst image and is the photo that Photos selected as the default image for the burst set, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_key">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_key</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.burst_key" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a burst photo and is the key image for the burst set (the image that Photos shows on top of the burst stack), otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_photos">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_photos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.PhotoInfo"><span class="pre">PhotoInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.burst_photos" title="Link to this definition">¶</a></dt>
<dd><p>If photo is a burst photo, returns list of PhotoInfo objects
that are part of the same burst photo set; otherwise returns empty list.
self is not included in the returned list</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.burst_selected">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_selected</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.burst_selected" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a burst photo and has been selected from the burst set by the user, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.cloud_guid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cloud_guid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.cloud_guid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.cloud_guid" title="Link to this definition">¶</a></dt>
<dd><p>Returns the GUID of the photo in iCloud (Photos 5+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.cloud_metadata">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cloud_metadata</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.cloud_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.cloud_metadata" title="Link to this definition">¶</a></dt>
<dd><p>Returns contents of ZCLOUDMASTERMEDIAMETADATA as dict; Photos 5+ only</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.cloud_owner_hashed_id">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cloud_owner_hashed_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.cloud_owner_hashed_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.cloud_owner_hashed_id" title="Link to this definition">¶</a></dt>
<dd><p>Returns the hashed iCloud ID of the owner of the shared photo (Photos 5+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.comments">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">comments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.CommentInfo" title="osxphotos.commentinfo.CommentInfo"><span class="pre">CommentInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.comments" title="Link to this definition">¶</a></dt>
<dd><p>Returns list of CommentInfo objects for any comments on the photo (sorted by date)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.date" title="Link to this definition">¶</a></dt>
<dd><p>Asset creation date as timezone aware datetime object</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date_added">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_added</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.date_added" title="Link to this definition">¶</a></dt>
<dd><p>Date photo was added to the database or None if no added date is recorded.</p>
<p>Returns a timezone aware datetime.datetime object in the local timezone</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date_modified">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_modified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.date_modified" title="Link to this definition">¶</a></dt>
<dd><p>Asset modification date as timezone aware datetime.datetime object
in local timezone or None if no modification date set</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date_original">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_original</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.date_original" title="Link to this definition">¶</a></dt>
<dd><p>Original creation date of asset as timezone aware datetime object.
If user has changed the asset's creation date in Photos, use this to access the original creation date
set when the asset was imported.</p>
<p>The original date is stored by Photos at import time
from the date in the photo's EXIF data. If this is not set (photo had no EXIF date) then 'date_original'
returns the same value as 'date'.</p>
<p>Photos 5+; on Photos version &lt; 5, returns the same value as 'date'.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.date_trashed">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_trashed</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.date_trashed" title="Link to this definition">¶</a></dt>
<dd><p>Date asset was placed in the trash or None.</p>
<p>Returns a timezone aware datetime.datetime object in the local timezone.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.description">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.description" title="Link to this definition">¶</a></dt>
<dd><p>long / extended description of picture</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.detected_text">
<span class="sig-name descname"><span class="pre">detected_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">confidence_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.75</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.detected_text"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.detected_text" title="Link to this definition">¶</a></dt>
<dd><p>Detects text in photo and returns lists of results as (detected text, confidence)</p>
<p>confidence_threshold: float between 0.0 and 1.0. If text detection confidence is below this threshold,
text will not be returned. Default is TEXT_DETECTION_CONFIDENCE_THRESHOLD</p>
<p>If photo is edited, uses the edited photo, otherwise the original; falls back to the preview image if neither edited or original is available</p>
<p>Returns: list of (detected text, confidence) tuples</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.duplicates">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">duplicates</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.PhotoInfo"><span class="pre">PhotoInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.duplicates" title="Link to this definition">¶</a></dt>
<dd><p>return list of PhotoInfo objects for possible duplicates (matching signature of original size, date, height, width) or empty list if no matching duplicates</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.exif_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">exif_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.ExifInfo" title="osxphotos.exifinfo.ExifInfo"><span class="pre">ExifInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.exif_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.exif_info" title="Link to this definition">¶</a></dt>
<dd><p>Returns an ExifInfo object with the EXIF data for photo
Note: the returned EXIF data is the data Photos stores in the database on import;
ExifInfo does not provide access to the EXIF info in the actual image file
Some or all of the fields may be None
Only valid for Photos 5; on earlier database returns None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.exiftool">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">exiftool</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ExifToolCaching</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.exiftool" title="Link to this definition">¶</a></dt>
<dd><p>Returns a ExifToolCaching (read-only instance of ExifTool) object for the photo.
Requires that exiftool (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) be installed
If exiftool not installed, logs warning and returns None
If photo path is missing, returns None</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.export">
<span class="sig-name descname"><span class="pre">export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edited</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live_photo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_photo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_as_hardlink</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">increment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_json</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_exiftool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_xmp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_photos_export</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">120</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_albums_as_keywords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_persons_as_keywords</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keyword_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description_template</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">render_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RenderOptions</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.export" title="Link to this definition">¶</a></dt>
<dd><p>Export a photo</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dest</strong> -- must be valid destination path (or exception raised)</p></li>
<li><p><strong>filename</strong> -- (optional): name of exported picture; if not provided, will use current filename
<strong>NOTE</strong>: if provided, user must ensure file extension (suffix) is correct.
For example, if photo is .CR2 file, edited image may be .jpeg.
If you provide an extension different than what the actual file is,
export will print a warning but will export the photo using the
incorrect file extension (unless use_photos_export is true, in which case export will
use the extension provided by Photos upon export; in this case, an incorrect extension is
silently ignored).
e.g. to get the extension of the edited photo,
reference PhotoInfo.path_edited</p></li>
<li><p><strong>edited</strong> -- (boolean, default=False); if True will export the edited version of the photo, otherwise exports the original version
(or raise exception if no edited version)</p></li>
<li><p><strong>live_photo</strong> -- (boolean, default=False); if True, will also export the associated .mov for live photos</p></li>
<li><p><strong>raw_photo</strong> -- (boolean, default=False); if True, will also export the associated RAW photo</p></li>
<li><p><strong>export_as_hardlink</strong> -- (boolean, default=False); if True, will hardlink files instead of copying them</p></li>
<li><p><strong>overwrite</strong> -- (boolean, default=False); if True will overwrite files if they already exist</p></li>
<li><p><strong>increment</strong> -- (boolean, default=True); if True, will increment file name until a non-existant name is found
if overwrite=False and increment=False, export will fail if destination file already exists</p></li>
<li><p><strong>sidecar_json</strong> -- if set will write a json sidecar with data in format readable by exiftool
sidecar filename will be dest/filename.json; includes exiftool tag group names (e.g. 'exiftool -G -j')</p></li>
<li><p><strong>sidecar_exiftool</strong> -- if set will write a json sidecar with data in format readable by exiftool
sidecar filename will be dest/filename.json; does not include exiftool tag group names (e.g. 'exiftool -j')</p></li>
<li><p><strong>sidecar_xmp</strong> -- if set will write an XMP sidecar with IPTC data
sidecar filename will be dest/filename.xmp</p></li>
<li><p><strong>use_photos_export</strong> -- (boolean, default=False); if True will attempt to export photo via applescript interaction with Photos</p></li>
<li><p><strong>timeout</strong> -- (int, default=120) timeout in seconds used with use_photos_export</p></li>
<li><p><strong>exiftool</strong> -- (boolean, default = False); if True, will use exiftool to write metadata to export file</p></li>
<li><p><strong>files</strong> (<em>returns list</em><em> of </em><em>full paths to the exported</em>)</p></li>
<li><p><strong>use_albums_as_keywords</strong> -- (boolean, default = False); if True, will include album names in keywords</p></li>
<li><p><strong>sidecar</strong> (<em>when exporting metadata with exiftool or</em>)</p></li>
<li><p><strong>use_persons_as_keywords</strong> -- (boolean, default = False); if True, will include person names in keywords</p></li>
<li><p><strong>sidecar</strong></p></li>
<li><p><strong>keyword_template</strong> -- (list of strings); list of template strings that will be rendered as used as keywords</p></li>
<li><p><strong>description_template</strong> -- string; optional template string that will be rendered for use as photo description</p></li>
<li><p><strong>render_options</strong> -- an optional osxphotos.phototemplate.RenderOptions instance with options to pass to template renderer</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of photos exported</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.external_edit">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">external_edit</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.external_edit" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if picture was edited outside of Photos using external editor</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.face_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">face_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.FaceInfo" title="osxphotos.personinfo.FaceInfo"><span class="pre">FaceInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.face_info" title="Link to this definition">¶</a></dt>
<dd><p>list of FaceInfo objects for faces in picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.favorite">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorite</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.favorite" title="Link to this definition">¶</a></dt>
<dd><p>True if picture is marked as favorite</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.filename">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.filename" title="Link to this definition">¶</a></dt>
<dd><p>filename of the picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.fingerprint">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fingerprint</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.fingerprint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.fingerprint" title="Link to this definition">¶</a></dt>
<dd><p>Returns fingerprint of original photo as a string or None if not available</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.flagged">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flagged</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.flagged" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is flagged; iPhoto only; on Photos always returns False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.has_raw">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">has_raw</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.has_raw" title="Link to this definition">¶</a></dt>
<dd><p>returns True if photo has an associated raw image (that is, it's a RAW+JPEG pair), otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.hasadjustments">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hasadjustments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.hasadjustments" title="Link to this definition">¶</a></dt>
<dd><p>True if picture has adjustments / edits</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.hdr">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hdr</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.hdr" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is an HDR photo, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.height">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">height</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.height" title="Link to this definition">¶</a></dt>
<dd><p>returns height of the current photo version in pixels</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.hexdigest">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hexdigest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.hexdigest"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.hexdigest" title="Link to this definition">¶</a></dt>
<dd><p>Returns a unique digest of the photo's properties and metadata;
useful for detecting changes in any property/metadata of the photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.hidden">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hidden</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.hidden" title="Link to this definition">¶</a></dt>
<dd><p>True if picture is hidden</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.import_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">import_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.ImportInfo" title="osxphotos.albuminfo.ImportInfo"><span class="pre">ImportInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.import_info" title="Link to this definition">¶</a></dt>
<dd><p>ImportInfo object representing import session for the photo or None if no import session</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.incloud">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">incloud</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.incloud" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is cloud asset and is synched to cloud
False if photo is cloud asset and not yet synched to cloud
None if photo is not cloud asset</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.intrash">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">intrash</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.intrash" title="Link to this definition">¶</a></dt>
<dd><p>True if picture is in trash ('Recently Deleted' folder)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.iscloudasset">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">iscloudasset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.iscloudasset" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a cloud asset (in an iCloud library),
otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ismissing">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ismissing</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ismissing" title="Link to this definition">¶</a></dt>
<dd><p>returns true if photo is missing from disk (which means it's not been downloaded from iCloud)</p>
<dl class="simple">
<dt>NOTE:   the photos.db database uses an asynchrounous write-ahead log so changes in Photos</dt><dd><p>do not immediately get written to disk. In particular, I've noticed that downloading
an image from the cloud does not force the database to be updated until something else
e.g. an edit, keyword, etc. occurs forcing a database synch
The exact process / timing is a mystery to be but be aware that if some photos were recently
downloaded from cloud to local storate their status in the database might still show
isMissing = 1</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.ismovie">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ismovie</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.ismovie" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if file is a movie, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.isphoto">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isphoto</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.isphoto" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if file is an image, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.israw">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">israw</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.israw" title="Link to this definition">¶</a></dt>
<dd><p>returns True if photo is a raw image. For images with an associated RAW+JPEG pair, see has_raw</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.isreference">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isreference</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.isreference" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a reference (not copied to the Photos library), otherwise False</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shallow</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.json" title="Link to this definition">¶</a></dt>
<dd><p>Return JSON representation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>indent</strong> -- indent level for JSON, if None, no indent</p></li>
<li><p><strong>shallow</strong> -- if True, return shallow JSON representation (does not contain folder_info, person_info, etc.)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>JSON string</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The shallow representation is used internally by export as it contains only the subset of data needed for export.</p>
</div>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.keywords">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.keywords" title="Link to this definition">¶</a></dt>
<dd><p>list of keywords for picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.labels">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">labels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.labels" title="Link to this definition">¶</a></dt>
<dd><p>returns list of labels applied to photo by Photos image categorization
only valid on Photos 5, on older libraries returns empty list</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.labels_normalized">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">labels_normalized</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.labels_normalized" title="Link to this definition">¶</a></dt>
<dd><p>returns normalized list of labels applied to photo by Photos image categorization
only valid on Photos 5, on older libraries returns empty list</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.latitude">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">latitude</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.latitude" title="Link to this definition">¶</a></dt>
<dd><p>Returns latitude as float in degrees or None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.likes">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">likes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.LikeInfo" title="osxphotos.commentinfo.LikeInfo"><span class="pre">LikeInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.likes" title="Link to this definition">¶</a></dt>
<dd><p>Returns list of LikeInfo objects for any likes on the photo (sorted by date)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.live_photo">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">live_photo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.live_photo" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a live photo, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.location">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">location</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.location" title="Link to this definition">¶</a></dt>
<dd><p>Returns (latitude, longitude) as float in degrees or None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.longitude">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">longitude</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.longitude" title="Link to this definition">¶</a></dt>
<dd><p>Returns longitude as float in degrees or None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.media_analysis">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media_analysis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.media_analysis"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.media_analysis" title="Link to this definition">¶</a></dt>
<dd><p>Returns media analysis results as a dictionary (Photos 5+)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.moment_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">moment_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.MomentInfo" title="osxphotos.momentinfo.MomentInfo"><span class="pre">MomentInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.moment_info" title="Link to this definition">¶</a></dt>
<dd><p>Moment photo belongs to</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.orientation">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">orientation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.orientation" title="Link to this definition">¶</a></dt>
<dd><p>returns EXIF orientation of the current photo version as int or 0 if current orientation cannot be determined</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_filename">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.original_filename" title="Link to this definition">¶</a></dt>
<dd><p>original filename of the picture
Photos 5 mangles filenames upon import</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_filesize">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_filesize</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.original_filesize" title="Link to this definition">¶</a></dt>
<dd><p>returns filesize of original photo in bytes as int</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_height">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_height</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.original_height" title="Link to this definition">¶</a></dt>
<dd><p>returns height of the original photo version in pixels</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_orientation">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_orientation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.original_orientation" title="Link to this definition">¶</a></dt>
<dd><p>returns EXIF orientation of the original photo version as int</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.original_width">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_width</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.original_width" title="Link to this definition">¶</a></dt>
<dd><p>returns width of the original photo version in pixels</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.owner">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">owner</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.owner" title="Link to this definition">¶</a></dt>
<dd><p>Return name of photo owner for shared photos (Photos 5+ only), or None if not shared</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.panorama">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">panorama</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.panorama" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a panorama, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.path" title="Link to this definition">¶</a></dt>
<dd><p>absolute path on disk of the original picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_derivatives">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path_derivatives</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.path_derivatives"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.path_derivatives" title="Link to this definition">¶</a></dt>
<dd><p>Return any derivative (preview) images associated with the photo as a list of paths, sorted by file size (largest first)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_edited">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path_edited</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.path_edited" title="Link to this definition">¶</a></dt>
<dd><p>absolute path on disk of the edited picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_edited_live_photo">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path_edited_live_photo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.path_edited_live_photo" title="Link to this definition">¶</a></dt>
<dd><p>return path to edited version of live photo movie</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_live_photo">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path_live_photo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.path_live_photo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.path_live_photo" title="Link to this definition">¶</a></dt>
<dd><p>Returns path to the associated video file for a live photo
If photo is not a live photo, returns None
If photo is missing, returns None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.path_raw">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path_raw</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.path_raw" title="Link to this definition">¶</a></dt>
<dd><p>absolute path of associated RAW image or None if there is not one</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.person_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">person_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PersonInfo" title="osxphotos.personinfo.PersonInfo"><span class="pre">PersonInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.person_info" title="Link to this definition">¶</a></dt>
<dd><p>list of PersonInfo objects for person in picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.persons">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">persons</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.persons" title="Link to this definition">¶</a></dt>
<dd><p>list of persons in picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.place">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">place</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">PlaceInfo4</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">PlaceInfo5</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.place" title="Link to this definition">¶</a></dt>
<dd><p>Returns PlaceInfo object containing reverse geolocation info</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.portrait">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">portrait</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.portrait" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a portrait, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.project_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.ProjectInfo" title="osxphotos.albuminfo.ProjectInfo"><span class="pre">ProjectInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.PhotoInfo.project_info" title="Link to this definition">¶</a></dt>
<dd><p>list of ProjectInfo objects representing projects for the photo or None if no projects</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.rating">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rating</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.rating" title="Link to this definition">¶</a></dt>
<dd><p>Star rating of photo as int from 0 to 5; for iPhoto, returns star rating; for Photos, always returns 0</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.raw_original">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">raw_original</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.raw_original" title="Link to this definition">¶</a></dt>
<dd><p>returns True if associated raw image and the raw image is selected in Photos
via &quot;Use RAW as Original &quot;
otherwise returns False</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.render_template">
<span class="sig-name descname"><span class="pre">render_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_str</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RenderOptions</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.render_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.render_template" title="Link to this definition">¶</a></dt>
<dd><p>Renders a template string for PhotoInfo instance using PhotoTemplate</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_str</strong> -- a template string with fields to render</p></li>
<li><p><strong>options</strong> -- a RenderOptions instance</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>tuple of list of rendered strings and list of unmatched template values</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>([rendered_strings], [unmatched])</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.saved_to_library">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">saved_to_library</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.saved_to_library"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.saved_to_library" title="Link to this definition">¶</a></dt>
<dd><p>Return True if syndicated photo has been saved to library;
returns False if photo is not syndicated or has not been saved to the library.
Returns None if not Photos 7+.
Syndicated photos are photos that appear in &quot;Shared with you&quot; album; Photos 7+ only.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.score">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">score</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.ScoreInfo" title="osxphotos.scoreinfo.ScoreInfo"><span class="pre">ScoreInfo</span></a></em><a class="headerlink" href="#osxphotos.PhotoInfo.score" title="Link to this definition">¶</a></dt>
<dd><p>Computed score information for a photo</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>ScoreInfo instance</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.screen_recording">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">screen_recording</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.screen_recording" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if video is a screen_recording, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.screenshot">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">screenshot</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.screenshot" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a screenshot, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.search_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.SearchInfo" title="osxphotos.searchinfo.SearchInfo"><span class="pre">SearchInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.search_info" title="Link to this definition">¶</a></dt>
<dd><p>returns SearchInfo object for photo
only valid on Photos 5, on older libraries, returns None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.search_info_normalized">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">search_info_normalized</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.SearchInfo" title="osxphotos.searchinfo.SearchInfo"><span class="pre">SearchInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.search_info_normalized" title="Link to this definition">¶</a></dt>
<dd><p>returns SearchInfo object for photo that produces normalized results
only valid on Photos 5, on older libraries, returns None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.selfie">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">selfie</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.selfie" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a selfie (front facing camera), otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.share_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">share_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ShareInfo</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.share_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.share_info" title="Link to this definition">¶</a></dt>
<dd><p>Returns ShareInfo object with information about the shared photo in a shared iCloud library (Photos 8+ only) (currently experimental)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.share_participant_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">share_participant_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">ShareParticipant</span><span class="p"><span class="pre">]</span></span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.share_participant_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.share_participant_info" title="Link to this definition">¶</a></dt>
<dd><p>Returns list of ShareParticipant objects with information on who the photo is shared with (Photos 8+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.share_participants">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">share_participants</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.share_participants"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.share_participants" title="Link to this definition">¶</a></dt>
<dd><p>Returns list of names of people the photo is shared with (Photos 8+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.shared">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">shared</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.shared" title="Link to this definition">¶</a></dt>
<dd><p>returns True if photos is in a shared iCloud album otherwise false
Only valid on Photos 5; returns None on older versions</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.shared_library">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">shared_library</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.shared_library"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.shared_library" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is in a shared iCloud library otherwise False (Photos 8+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.shared_moment">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">shared_moment</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.shared_moment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.shared_moment" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is part of a shared moment otherwise False (Photos 7+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.shared_moment_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">shared_moment_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ShareInfo</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.shared_moment_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.shared_moment_info" title="Link to this definition">¶</a></dt>
<dd><p>Returns ShareInfo object with information about the shared moment the photo is part of (Photos 7+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.slow_mo">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">slow_mo</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.slow_mo" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a slow motion video, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.syndicated">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">syndicated</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.syndicated"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.syndicated" title="Link to this definition">¶</a></dt>
<dd><p>Return true if photo was shared via syndication (e.g. via Messages, etc.);
these are photos that appear in &quot;Shared with you&quot; album.
Photos 7+ only; returns None if not Photos 7+.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.tables">
<span class="sig-name descname"><span class="pre">tables</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">PhotoTables</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/osxphotos/photoinfo.html#PhotoInfo.tables"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoInfo.tables" title="Link to this definition">¶</a></dt>
<dd><p>Return PhotoTables object to provide access database tables associated with this photo (Photos 5+)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.time_lapse">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">time_lapse</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.time_lapse" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is a time lapse video, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.title">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.title" title="Link to this definition">¶</a></dt>
<dd><p>name / title of picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.tzname">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tzname</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.tzname" title="Link to this definition">¶</a></dt>
<dd><p>Timezone name for the asset creation date; on Photos version &lt; 5, returns None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.tzoffset">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tzoffset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.tzoffset" title="Link to this definition">¶</a></dt>
<dd><p>Timezone offset from UTC in seconds for the Photo creation date</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uti">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uti</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.uti" title="Link to this definition">¶</a></dt>
<dd><p>Returns Uniform Type Identifier (UTI) for the image
for example: public.jpeg or com.apple.quicktime-movie</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uti_edited">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uti_edited</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.uti_edited" title="Link to this definition">¶</a></dt>
<dd><p>Returns Uniform Type Identifier (UTI) for the edited image
if the photo has been edited, otherwise None;
for example: public.jpeg</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uti_original">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uti_original</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.uti_original" title="Link to this definition">¶</a></dt>
<dd><p>Returns Uniform Type Identifier (UTI) for the original image
for example: public.jpeg or com.apple.quicktime-movie</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uti_raw">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uti_raw</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.uti_raw" title="Link to this definition">¶</a></dt>
<dd><p>Returns Uniform Type Identifier (UTI) for the RAW image if there is one
for example: com.canon.cr2-raw-image
Returns None if no associated RAW image</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.uuid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uuid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.uuid" title="Link to this definition">¶</a></dt>
<dd><p>UUID of picture</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.visible">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">visible</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.visible" title="Link to this definition">¶</a></dt>
<dd><p>True if picture is visble</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.width">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">width</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.PhotoInfo.width" title="Link to this definition">¶</a></dt>
<dd><p>returns width of the current photo version in pixels</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotoTemplate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate" title="Link to this definition">¶</a></dt>
<dd><p>PhotoTemplate class to render a template string from a PhotoInfo object</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.expand_variables">
<span class="sig-name descname"><span class="pre">expand_variables</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.expand_variables"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.expand_variables" title="Link to this definition">¶</a></dt>
<dd><p>Expand variables in value</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.expand_variables_to_str">
<span class="sig-name descname"><span class="pre">expand_variables_to_str</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.expand_variables_to_str"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.expand_variables_to_str" title="Link to this definition">¶</a></dt>
<dd><p>Expand variables in value and return a str of the expanded value.
Enforce that the expanded value is a single value, raises ValueError if not.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>value</strong> -- the value to expand</p></li>
<li><p><strong>name</strong> -- the name of the value being expanded (used in error messages)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.filter_predicate">
<span class="sig-name descname"><span class="pre">filter_predicate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.filter_predicate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.filter_predicate" title="Link to this definition">¶</a></dt>
<dd><p>Return True if value passes predicate</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_field_values">
<span class="sig-name descname"><span class="pre">get_field_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subfield</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field_arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_field_values"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_field_values" title="Link to this definition">¶</a></dt>
<dd><p>Get the values for a field</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_filter_values">
<span class="sig-name descname"><span class="pre">get_filter_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_filter_values"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_filter_values" title="Link to this definition">¶</a></dt>
<dd><p>Return filtered values</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_format_values">
<span class="sig-name descname"><span class="pre">get_format_values</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subfield</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_format_values"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_format_values" title="Link to this definition">¶</a></dt>
<dd><p>Return values for {format} templates</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_media_type">
<span class="sig-name descname"><span class="pre">get_media_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_media_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_media_type" title="Link to this definition">¶</a></dt>
<dd><p>return special media type, e.g. slow_mo, panorama, etc., defaults to photo or video if no special type</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_photo_bool_attribute">
<span class="sig-name descname"><span class="pre">get_photo_bool_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">attr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bool_val</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_photo_bool_attribute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_photo_bool_attribute" title="Link to this definition">¶</a></dt>
<dd><p>Return the boolean value for a photo attribute</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_photo_video_type">
<span class="sig-name descname"><span class="pre">get_photo_video_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_photo_video_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_photo_video_type" title="Link to this definition">¶</a></dt>
<dd><p>return media type, e.g. photo or video</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value">
<span class="sig-name descname"><span class="pre">get_template_value</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subfield</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field_arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value" title="Link to this definition">¶</a></dt>
<dd><p>lookup value for template field (single-value template substitutions)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>field</strong> -- template field to find value for.</p></li>
<li><p><strong>default</strong> -- the default value provided by the user</p></li>
<li><p><strong>bool_val</strong> -- True value if expression is boolean</p></li>
<li><p><strong>delim</strong> -- delimiter for expand in place</p></li>
<li><p><strong>path_sep</strong> -- path separator for fields that are path-like</p></li>
<li><p><strong>subfield</strong> -- subfield (value after : in field)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The matching template value (which may be None).</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ValueError if no rule exists for field.</strong> -- </p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_exiftool">
<span class="sig-name descname"><span class="pre">get_template_value_exiftool</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subfield</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_exiftool"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_exiftool" title="Link to this definition">¶</a></dt>
<dd><p>Get template value for format &quot;{exiftool:EXIF:Model}&quot;</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_filter_function">
<span class="sig-name descname"><span class="pre">get_template_value_filter_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">filter_</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_filter_function"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_filter_function" title="Link to this definition">¶</a></dt>
<dd><p>Filter template value from external function</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_function">
<span class="sig-name descname"><span class="pre">get_template_value_function</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">subfield</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">field_arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">caller</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_function"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_function" title="Link to this definition">¶</a></dt>
<dd><p>Get template value from external function</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>subfield</strong> -- the filename and function name in for filename.py::function</p></li>
<li><p><strong>field_arg</strong> -- the argument to pass to the function</p></li>
<li><p><strong>caller</strong> -- the calling source of the template ('export' or 'import')</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_multi">
<span class="sig-name descname"><span class="pre">get_template_value_multi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subfield</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path_sep</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_multi"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_multi" title="Link to this definition">¶</a></dt>
<dd><p>lookup value for template field (multi-value template substitutions)</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>field</strong> -- template field to find value for.</p></li>
<li><p><strong>subfield</strong> -- the template subfield value</p></li>
<li><p><strong>path_sep</strong> -- path separator to use for folder_album field</p></li>
<li><p><strong>default</strong> -- value of default field</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>List of the matching template values or [].</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ValueError if no rule exists for field.</strong> -- </p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.get_template_value_pathlib">
<span class="sig-name descname"><span class="pre">get_template_value_pathlib</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.get_template_value_pathlib"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.get_template_value_pathlib" title="Link to this definition">¶</a></dt>
<dd><p>lookup value for template pathlib template fields</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>field</strong> -- template field to find value for.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The matching template value (which may be None).</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>ValueError if no rule exists for field.</strong> -- </p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoTemplate.render">
<span class="sig-name descname"><span class="pre">render</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RenderOptions</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/phototemplate.html#PhotoTemplate.render"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotoTemplate.render" title="Link to this definition">¶</a></dt>
<dd><p>Render a filename or directory template</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template</strong> -- str template</p></li>
<li><p><strong>options</strong> -- a RenderOptions instance</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>tuple of list of rendered strings and list of unmatched template values</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>([rendered_strings], [unmatched])</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.PhotosAlbum">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotosAlbum</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rich</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosalbum.html#PhotosAlbum"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosAlbum" title="Link to this definition">¶</a></dt>
<dd><p>Add osxphotos.photoinfo.PhotoInfo objects to album</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosAlbum.append">
<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.PhotoInfo"><span class="pre">PhotoInfo</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosalbum.html#PhotosAlbum.append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosAlbum.append" title="Link to this definition">¶</a></dt>
<dd><p>Add photo to album</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosAlbum.extend">
<span class="sig-name descname"><span class="pre">extend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.PhotoInfo"><span class="pre">PhotoInfo</span></a><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosalbum.html#PhotosAlbum.extend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosAlbum.extend" title="Link to this definition">¶</a></dt>
<dd><p>Add list of photos to album</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.PhotosAlbumPhotoScript">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotosAlbumPhotoScript</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">split_folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rich</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosalbum.html#PhotosAlbumPhotoScript"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosAlbumPhotoScript" title="Link to this definition">¶</a></dt>
<dd><p>Add photoscript.Photo objects to album</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosAlbumPhotoScript.append">
<span class="sig-name descname"><span class="pre">append</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Photo</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosalbum.html#PhotosAlbumPhotoScript.append"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosAlbumPhotoScript.append" title="Link to this definition">¶</a></dt>
<dd><p>Add photo to album</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosAlbumPhotoScript.extend">
<span class="sig-name descname"><span class="pre">extend</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">Photo</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosalbum.html#PhotosAlbumPhotoScript.extend"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosAlbumPhotoScript.extend" title="Link to this definition">¶</a></dt>
<dd><p>Add list of photos to album</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.PhotosDB">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PhotosDB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbfile</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rich</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">library_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_skip_searchinfo</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB" title="Link to this definition">¶</a></dt>
<dd><p>Processes a Photos.app library database to extract information about photos</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.album_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">album_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.album_info" title="Link to this definition">¶</a></dt>
<dd><p>Return list of AlbumInfo objects for each album in the photos database</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.album_info_shared">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">album_info_shared</span></span><a class="headerlink" href="#osxphotos.PhotosDB.album_info_shared" title="Link to this definition">¶</a></dt>
<dd><p>Return list of AlbumInfo objects for each shared album in the photos database
only valid for Photos 5; on Photos &lt;= 4, prints warning and returns empty list</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.albums">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">albums</span></span><a class="headerlink" href="#osxphotos.PhotosDB.albums" title="Link to this definition">¶</a></dt>
<dd><p>Return list of albums found in photos database</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.albums_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">albums_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.albums_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>Return albums as dict of albums, count in reverse sorted order (descending)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.albums_shared">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">albums_shared</span></span><a class="headerlink" href="#osxphotos.PhotosDB.albums_shared" title="Link to this definition">¶</a></dt>
<dd><p>Return list of shared albums found in photos database
only valid for Photos 5; on Photos &lt;= 4, prints warning and returns empty list</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.albums_shared_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">albums_shared_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.albums_shared_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>Returns shared albums as dict of albums, count in reverse sorted order (descending)
valid only on Photos 5; on Photos &lt;= 4, prints warning and returns empty dict</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.db_path">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">db_path</span></span><a class="headerlink" href="#osxphotos.PhotosDB.db_path" title="Link to this definition">¶</a></dt>
<dd><p>Returns path to the Photos library database</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.db_version">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">db_version</span></span><a class="headerlink" href="#osxphotos.PhotosDB.db_version" title="Link to this definition">¶</a></dt>
<dd><p>Return the Photos database version</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.execute">
<span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sql</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">params</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Cursor</span></span></span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.execute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.execute" title="Link to this definition">¶</a></dt>
<dd><p>Execute sql statement and return cursor</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.folder_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.folder_info" title="Link to this definition">¶</a></dt>
<dd><p>Return list FolderInfo objects representing top-level folders in the photos database</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.folders">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folders</span></span><a class="headerlink" href="#osxphotos.PhotosDB.folders" title="Link to this definition">¶</a></dt>
<dd><p>Return list of top-level folder names in the photos database</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.get_db_connection">
<span class="sig-name descname"><span class="pre">get_db_connection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.get_db_connection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.get_db_connection" title="Link to this definition">¶</a></dt>
<dd><p>Get connection to the working copy of the Photos database</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple of (connection, cursor) to sqlite3 database</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.get_photo">
<span class="sig-name descname"><span class="pre">get_photo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.get_photo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.get_photo" title="Link to this definition">¶</a></dt>
<dd><p>Returns a single photo matching uuid</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>uuid</strong> -- the UUID of photo to get</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>PhotoInfo instance for photo with UUID matching uuid or None if no match</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.import_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">import_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.import_info" title="Link to this definition">¶</a></dt>
<dd><p>Return list of ImportInfo objects for each import session in the database</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.keywords">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keywords</span></span><a class="headerlink" href="#osxphotos.PhotosDB.keywords" title="Link to this definition">¶</a></dt>
<dd><p>Return list of keywords found in photos database and associated with at least one photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.keywords_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keywords_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.keywords_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>count in reverse sorted order (descending)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Return keywords as dict of keyword</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.keywords_without_photo">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keywords_without_photo</span></span><a class="headerlink" href="#osxphotos.PhotosDB.keywords_without_photo" title="Link to this definition">¶</a></dt>
<dd><p>Return keywords that exist in the database but are not assined to any photo (Photos 5+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.labels">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">labels</span></span><a class="headerlink" href="#osxphotos.PhotosDB.labels" title="Link to this definition">¶</a></dt>
<dd><p>return list of all search info labels found in the library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.labels_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">labels_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.labels_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>count in reverse sorted order (descending)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>return labels as dict of label</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.labels_normalized">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">labels_normalized</span></span><a class="headerlink" href="#osxphotos.PhotosDB.labels_normalized" title="Link to this definition">¶</a></dt>
<dd><p>return list of all normalized search info labels found in the library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.labels_normalized_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">labels_normalized_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.labels_normalized_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>count in reverse sorted order (descending)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>return normalized labels as dict of label</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.library_path">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">library_path</span></span><a class="headerlink" href="#osxphotos.PhotosDB.library_path" title="Link to this definition">¶</a></dt>
<dd><p>Returns path to the Photos library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.person_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">person_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.person_info" title="Link to this definition">¶</a></dt>
<dd><p>Return list of PersonInfo objects for each person in the photos database</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.persons">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">persons</span></span><a class="headerlink" href="#osxphotos.PhotosDB.persons" title="Link to this definition">¶</a></dt>
<dd><p>Return list of persons found in photos database and associated with at least one photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.persons_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">persons_as_dict</span></span><a class="headerlink" href="#osxphotos.PhotosDB.persons_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>Return persons as dict of person, count in reverse sorted order (descending)</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.photos">
<span class="sig-name descname"><span class="pre">photos</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persons</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">albums</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">images</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">movies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intrash</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.PhotoInfo"><span class="pre">PhotoInfo</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.photos"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.photos" title="Link to this definition">¶</a></dt>
<dd><p>Return a list of PhotoInfo objects
If called with no args, returns the entire database of photos
If called with args, returns photos matching the args (e.g. keywords, persons, etc.)
If more than one arg, returns photos matching all the criteria (e.g. keywords AND persons)
If more than one keyword, uuid, persons, albums is passed, they are treated as &quot;OR&quot; criteria
e.g. keywords=[&quot;wedding&quot;,&quot;vacation&quot;] returns photos matching either keyword
from_date and to_date may be either naive or timezone-aware datetime.datetime objects.
If naive, timezone will be assumed to be local timezone.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>keywords</strong> -- list of keywords to search for</p></li>
<li><p><strong>uuid</strong> -- list of UUIDs to search for</p></li>
<li><p><strong>persons</strong> -- list of persons to search for</p></li>
<li><p><strong>albums</strong> -- list of album names to search for</p></li>
<li><p><strong>images</strong> -- if True, returns image files, if False, does not return images; default is True</p></li>
<li><p><strong>movies</strong> -- if True, returns movie files, if False, does not return movies; default is True</p></li>
<li><p><strong>from_date</strong> -- return photos with creation date &gt;= from_date (datetime.datetime object, default None)</p></li>
<li><p><strong>to_date</strong> -- return photos with creation date &lt; to_date (datetime.datetime object, default None)</p></li>
<li><p><strong>intrash</strong> -- if True, returns only images in &quot;Recently deleted items&quot; folder,
if False returns only photos that aren't deleted; default is False</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of PhotoInfo objects</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.photos_by_uuid">
<span class="sig-name descname"><span class="pre">photos_by_uuid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuids</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.photos_by_uuid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.photos_by_uuid" title="Link to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>Returns a list of photos with UUID in uuids.</dt><dd><p>Does not generate error if invalid or missing UUID passed.
This is faster than using PhotosDB.photos if you have list of UUIDs.
Returns photos regardless of intrash state.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>uuid</strong> -- list of UUIDs of photos to get</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of PhotoInfo instance for photo with UUID matching uuid or [] if no match</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.photos_version">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos_version</span></span><a class="headerlink" href="#osxphotos.PhotosDB.photos_version" title="Link to this definition">¶</a></dt>
<dd><p>Returns version of Photos app that created the library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.project_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">project_info</span></span><a class="headerlink" href="#osxphotos.PhotosDB.project_info" title="Link to this definition">¶</a></dt>
<dd><p>Return list of AlbumInfo projects for each project in the database</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.query">
<span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.QueryOptions" title="osxphotos.photoquery.QueryOptions"><span class="pre">QueryOptions</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.PhotoInfo"><span class="pre">PhotoInfo</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.query" title="Link to this definition">¶</a></dt>
<dd><p>Run a query against PhotosDB to extract the photos based on user supplied options</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>options</strong> -- a QueryOptions instance</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.PlaceInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">PlaceInfo</span></span><a class="reference internal" href="_modules/osxphotos/placeinfo.html#PlaceInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PlaceInfo" title="Link to this definition">¶</a></dt>
<dd><p>Reverse geolocation place info for a photo.</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PlaceInfo.address">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">address</span></span><a class="headerlink" href="#osxphotos.PlaceInfo.address" title="Link to this definition">¶</a></dt>
<dd><p>Returns a 'PostalAddress' namedtuple with details of the postal address containing the following fields:</p>
<ul class="simple">
<li><p>'city'</p></li>
<li><p>'country'</p></li>
<li><p>'postal_code'</p></li>
<li><p>'state'</p></li>
<li><p>'street'</p></li>
<li><p>'sub_administrative_area'</p></li>
<li><p>'sub_locality'</p></li>
<li><p>'iso_country_code'</p></li>
</ul>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PlaceInfo.address_str">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">address_str</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PlaceInfo.address_str" title="Link to this definition">¶</a></dt>
<dd><p>Returns the full postal address as a string if defined, otherwise 'None'.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PlaceInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/placeinfo.html#PlaceInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PlaceInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Returns a dictionary representation of the PlaceInfo object.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PlaceInfo.country_code">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">country_code</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PlaceInfo.country_code" title="Link to this definition">¶</a></dt>
<dd><p>Returns the country_code of place, for example &quot;GB&quot;.
Returns 'None' if PhotoInfo contains no country code.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PlaceInfo.ishome">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ishome</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.PlaceInfo.ishome" title="Link to this definition">¶</a></dt>
<dd><p>Returns 'True' if photo place is user's home address, otherwise 'False'.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PlaceInfo.name">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PlaceInfo.name" title="Link to this definition">¶</a></dt>
<dd><p>Returns the name of the local place as str.
This is what Photos displays in the Info window.
<strong>Note</strong> Photos 5 uses a different algorithm to determine the name than earlier versions which means the same Photo may have a different place name in Photos 4 and Photos 5.
'PhotoInfo.name' will return the name Photos would have shown depending on the version of the library being processed.
Returns 'None' if photo does not contain a name.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.PlaceInfo.names">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">names</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">PlaceNames</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.PlaceInfo.names" title="Link to this definition">¶</a></dt>
<dd><p>Returns a 'PlaceNames' namedtuple with the following fields.
Each field is a list with zero or more values, sorted by area in ascending order.
E.g. 'names.area_of_interest' could be ['Gulf Islands National Seashore', 'Santa Rosa Island'], [&quot;Knott's Berry Farm&quot;], or [] if 'area_of_interest' not defined.
The value shown in Photos is the first value in the list. With the exception of 'body_of_water' each of these field corresponds to an attribute of
a [CLPlacemark](<a class="reference external" href="https://developer.apple.com/documentation/corelocation/clplacemark">https://developer.apple.com/documentation/corelocation/clplacemark</a>) object.</p>
<ul class="simple">
<li><p>'country'; the name of the country associated with the placemark.</p></li>
<li><p>'state_province'; administrativeArea, The state or province associated with the placemark.</p></li>
<li><p>'sub_administrative_area'; additional administrative area information for the placemark.</p></li>
<li><p>'city'; locality; the city associated with the placemark.</p></li>
<li><p>'additional_city_info'; subLocality, Additional city-level information for the placemark.</p></li>
<li><p>'ocean'; the name of the ocean associated with the placemark.</p></li>
<li><p>'area_of_interest'; areasOfInterest, The relevant areas of interest associated with the placemark.</p></li>
<li><p>'inland_water'; the name of the inland water body associated with the placemark.</p></li>
<li><p>'region'; the geographic region associated with the placemark.</p></li>
<li><p>'sub_throughfare'; additional street-level information for the placemark.</p></li>
<li><p>'postal_code'; the postal code associated with the placemark.</p></li>
<li><p>'street_address'; throughfare, The street address associated with the placemark.</p></li>
<li><p>'body_of_water'; in Photos 4, any body of water; in Photos 5 contains the union of ocean and inland_water</p></li>
</ul>
<p><strong>Note</strong>: In Photos &lt;= 4.0, only the following fields are defined; all others are set to empty list:</p>
<ul class="simple">
<li><p>'country'</p></li>
<li><p>'state_province'</p></li>
<li><p>'sub_administrative_area'</p></li>
<li><p>'city'</p></li>
<li><p>'additional_city_info'</p></li>
<li><p>'area_of_interest'</p></li>
<li><p>'body_of_water'</p></li>
</ul>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The 'PlaceNames' namedtuple contains reserved fields not listed below (see implementation for details),
thus it should be referenced only by name (e.g. 'names.city') and not by index.</p>
</div>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ProjectInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ProjectInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">db</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/albuminfo.html#ProjectInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ProjectInfo" title="Link to this definition">¶</a></dt>
<dd><p>ProjectInfo with info about projects
Projects are cards, calendars, slideshows, etc.</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ProjectInfo.folder_list">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_list</span></span><a class="headerlink" href="#osxphotos.ProjectInfo.folder_list" title="Link to this definition">¶</a></dt>
<dd><p>Returns list of FolderInfo objects for each folder the album is contained in
or empty list if album is not in any folders</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.ProjectInfo.folder_names">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_names</span></span><a class="headerlink" href="#osxphotos.ProjectInfo.folder_names" title="Link to this definition">¶</a></dt>
<dd><p>Return hierarchical list of folders the album is contained in
the folder list is in form:
[&quot;Top level folder&quot;, &quot;sub folder 1&quot;, &quot;sub folder 2&quot;, ...]
or empty list if album is not in any folders</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.QueryOptions">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">QueryOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">added_after</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">added_before</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">added_in_last</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.timedelta</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">burst_photos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">burst</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cloudasset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted_only</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">deleted</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">duplicate</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edited</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exif</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">external_edit</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">favorite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.time</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">function</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">callable</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">has_comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">has_likes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">has_raw</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hdr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">hidden</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_case</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">in_album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">incloud</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_reference</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keyword</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">label</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">live</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bitmath.Byte</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_size</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bitmath.Byte</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missing_bursts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">missing</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">movies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_comment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_likes</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_location</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_keyword</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_place</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">no_title</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_burst</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_cloudasset</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_edited</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_favorite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_hdr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_hidden</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_in_album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_incloud</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_live</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_missing</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_panorama</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_portrait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_reference</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_screenshot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_screen_recording</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_selfie</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_shared</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_slow_mo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_time_lapse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">panorama</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">person</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">photos</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">place</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">portrait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query_eval</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">regex</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">screenshot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">screen_recording</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selected</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">selfie</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shared</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">slow_mo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">time_lapse</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_time</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime.time</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uti</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">year</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Iterable</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">syndicated</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_syndicated</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">saved_to_library</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_saved_to_library</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shared_moment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_shared_moment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shared_library</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">not_shared_library</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/photoquery.html#QueryOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.QueryOptions" title="Link to this definition">¶</a></dt>
<dd><p>QueryOptions class for PhotosDB.query</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.added_after">
<span class="sig-name descname"><span class="pre">added_after</span></span><a class="headerlink" href="#osxphotos.QueryOptions.added_after" title="Link to this definition">¶</a></dt>
<dd><p>search for photos added on or after a given date</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[datetime.datetime]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.added_before">
<span class="sig-name descname"><span class="pre">added_before</span></span><a class="headerlink" href="#osxphotos.QueryOptions.added_before" title="Link to this definition">¶</a></dt>
<dd><p>search for photos added before a given date</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[datetime.datetime]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.added_in_last">
<span class="sig-name descname"><span class="pre">added_in_last</span></span><a class="headerlink" href="#osxphotos.QueryOptions.added_in_last" title="Link to this definition">¶</a></dt>
<dd><p>search for photos added in last X datetime.timedelta</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[datetime.timedelta]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.album">
<span class="sig-name descname"><span class="pre">album</span></span><a class="headerlink" href="#osxphotos.QueryOptions.album" title="Link to this definition">¶</a></dt>
<dd><p>list of album names to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.burst_photos">
<span class="sig-name descname"><span class="pre">burst_photos</span></span><a class="headerlink" href="#osxphotos.QueryOptions.burst_photos" title="Link to this definition">¶</a></dt>
<dd><p>include all associated burst photos for photos in query results</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.burst">
<span class="sig-name descname"><span class="pre">burst</span></span><a class="headerlink" href="#osxphotos.QueryOptions.burst" title="Link to this definition">¶</a></dt>
<dd><p>search for burst photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.cloudasset">
<span class="sig-name descname"><span class="pre">cloudasset</span></span><a class="headerlink" href="#osxphotos.QueryOptions.cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that are managed by iCloud</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.deleted_only">
<span class="sig-name descname"><span class="pre">deleted_only</span></span><a class="headerlink" href="#osxphotos.QueryOptions.deleted_only" title="Link to this definition">¶</a></dt>
<dd><p>search only for deleted photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.deleted">
<span class="sig-name descname"><span class="pre">deleted</span></span><a class="headerlink" href="#osxphotos.QueryOptions.deleted" title="Link to this definition">¶</a></dt>
<dd><p>also include deleted photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.description">
<span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#osxphotos.QueryOptions.description" title="Link to this definition">¶</a></dt>
<dd><p>list of descriptions to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.duplicate">
<span class="sig-name descname"><span class="pre">duplicate</span></span><a class="headerlink" href="#osxphotos.QueryOptions.duplicate" title="Link to this definition">¶</a></dt>
<dd><p>search for duplicate photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.edited">
<span class="sig-name descname"><span class="pre">edited</span></span><a class="headerlink" href="#osxphotos.QueryOptions.edited" title="Link to this definition">¶</a></dt>
<dd><p>search for edited photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.exif">
<span class="sig-name descname"><span class="pre">exif</span></span><a class="headerlink" href="#osxphotos.QueryOptions.exif" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with EXIF tags that matches the given data</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[Tuple[str, str]]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.external_edit">
<span class="sig-name descname"><span class="pre">external_edit</span></span><a class="headerlink" href="#osxphotos.QueryOptions.external_edit" title="Link to this definition">¶</a></dt>
<dd><p>search for photos edited in external apps</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.favorite">
<span class="sig-name descname"><span class="pre">favorite</span></span><a class="headerlink" href="#osxphotos.QueryOptions.favorite" title="Link to this definition">¶</a></dt>
<dd><p>search for favorite photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.folder">
<span class="sig-name descname"><span class="pre">folder</span></span><a class="headerlink" href="#osxphotos.QueryOptions.folder" title="Link to this definition">¶</a></dt>
<dd><p>list of folder names to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.from_date">
<span class="sig-name descname"><span class="pre">from_date</span></span><a class="headerlink" href="#osxphotos.QueryOptions.from_date" title="Link to this definition">¶</a></dt>
<dd><p>search for photos taken on or after this date</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[datetime.datetime]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.from_time">
<span class="sig-name descname"><span class="pre">from_time</span></span><a class="headerlink" href="#osxphotos.QueryOptions.from_time" title="Link to this definition">¶</a></dt>
<dd><p>search for photos taken on or after this time of day</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[datetime.time]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.function">
<span class="sig-name descname"><span class="pre">function</span></span><a class="headerlink" href="#osxphotos.QueryOptions.function" title="Link to this definition">¶</a></dt>
<dd><p>list of query functions to evaluate</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[List[Tuple[callable, str]]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.has_comment">
<span class="sig-name descname"><span class="pre">has_comment</span></span><a class="headerlink" href="#osxphotos.QueryOptions.has_comment" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with comments</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.has_likes">
<span class="sig-name descname"><span class="pre">has_likes</span></span><a class="headerlink" href="#osxphotos.QueryOptions.has_likes" title="Link to this definition">¶</a></dt>
<dd><p>search for shared photos with likes</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.has_raw">
<span class="sig-name descname"><span class="pre">has_raw</span></span><a class="headerlink" href="#osxphotos.QueryOptions.has_raw" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with associated raw files</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.hdr">
<span class="sig-name descname"><span class="pre">hdr</span></span><a class="headerlink" href="#osxphotos.QueryOptions.hdr" title="Link to this definition">¶</a></dt>
<dd><p>search for HDR photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.hidden">
<span class="sig-name descname"><span class="pre">hidden</span></span><a class="headerlink" href="#osxphotos.QueryOptions.hidden" title="Link to this definition">¶</a></dt>
<dd><p>search for hidden photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.ignore_case">
<span class="sig-name descname"><span class="pre">ignore_case</span></span><a class="headerlink" href="#osxphotos.QueryOptions.ignore_case" title="Link to this definition">¶</a></dt>
<dd><p>ignore case when searching</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.in_album">
<span class="sig-name descname"><span class="pre">in_album</span></span><a class="headerlink" href="#osxphotos.QueryOptions.in_album" title="Link to this definition">¶</a></dt>
<dd><p>search for photos in an album</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.incloud">
<span class="sig-name descname"><span class="pre">incloud</span></span><a class="headerlink" href="#osxphotos.QueryOptions.incloud" title="Link to this definition">¶</a></dt>
<dd><p>search for cloud assets that are synched to iCloud</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.is_reference">
<span class="sig-name descname"><span class="pre">is_reference</span></span><a class="headerlink" href="#osxphotos.QueryOptions.is_reference" title="Link to this definition">¶</a></dt>
<dd><p>search for photos stored by reference (that is, they are not managed by Photos)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.keyword">
<span class="sig-name descname"><span class="pre">keyword</span></span><a class="headerlink" href="#osxphotos.QueryOptions.keyword" title="Link to this definition">¶</a></dt>
<dd><p>list of keywords to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.label">
<span class="sig-name descname"><span class="pre">label</span></span><a class="headerlink" href="#osxphotos.QueryOptions.label" title="Link to this definition">¶</a></dt>
<dd><p>list of labels to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.live">
<span class="sig-name descname"><span class="pre">live</span></span><a class="headerlink" href="#osxphotos.QueryOptions.live" title="Link to this definition">¶</a></dt>
<dd><p>search for live photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.location">
<span class="sig-name descname"><span class="pre">location</span></span><a class="headerlink" href="#osxphotos.QueryOptions.location" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with a location</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.max_size">
<span class="sig-name descname"><span class="pre">max_size</span></span><a class="headerlink" href="#osxphotos.QueryOptions.max_size" title="Link to this definition">¶</a></dt>
<dd><p>maximum size of photos to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bitmath.Byte]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.min_size">
<span class="sig-name descname"><span class="pre">min_size</span></span><a class="headerlink" href="#osxphotos.QueryOptions.min_size" title="Link to this definition">¶</a></dt>
<dd><p>minimum size of photos to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bitmath.Byte]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.missing_bursts">
<span class="sig-name descname"><span class="pre">missing_bursts</span></span><a class="headerlink" href="#osxphotos.QueryOptions.missing_bursts" title="Link to this definition">¶</a></dt>
<dd><p>for burst photos, also include burst photos that are missing</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.missing">
<span class="sig-name descname"><span class="pre">missing</span></span><a class="headerlink" href="#osxphotos.QueryOptions.missing" title="Link to this definition">¶</a></dt>
<dd><p>search for missing photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.movies">
<span class="sig-name descname"><span class="pre">movies</span></span><a class="headerlink" href="#osxphotos.QueryOptions.movies" title="Link to this definition">¶</a></dt>
<dd><p>search for movies</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.name">
<span class="sig-name descname"><span class="pre">name</span></span><a class="headerlink" href="#osxphotos.QueryOptions.name" title="Link to this definition">¶</a></dt>
<dd><p>list of names to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_comment">
<span class="sig-name descname"><span class="pre">no_comment</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_comment" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with no comments</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_description">
<span class="sig-name descname"><span class="pre">no_description</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_description" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with no description</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_likes">
<span class="sig-name descname"><span class="pre">no_likes</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_likes" title="Link to this definition">¶</a></dt>
<dd><p>search for shared photos with no likes</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_location">
<span class="sig-name descname"><span class="pre">no_location</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_location" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with no location</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_keyword">
<span class="sig-name descname"><span class="pre">no_keyword</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_keyword" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with no keywords</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_place">
<span class="sig-name descname"><span class="pre">no_place</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_place" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with no place</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.no_title">
<span class="sig-name descname"><span class="pre">no_title</span></span><a class="headerlink" href="#osxphotos.QueryOptions.no_title" title="Link to this definition">¶</a></dt>
<dd><p>search for photos with no title</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_burst">
<span class="sig-name descname"><span class="pre">not_burst</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_burst" title="Link to this definition">¶</a></dt>
<dd><p>search for non-burst photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_cloudasset">
<span class="sig-name descname"><span class="pre">not_cloudasset</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_cloudasset" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that are not managed by iCloud</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_edited">
<span class="sig-name descname"><span class="pre">not_edited</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_edited" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that have not been edited</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_favorite">
<span class="sig-name descname"><span class="pre">not_favorite</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_favorite" title="Link to this definition">¶</a></dt>
<dd><p>search for non-favorite photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_hdr">
<span class="sig-name descname"><span class="pre">not_hdr</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_hdr" title="Link to this definition">¶</a></dt>
<dd><p>search for non-HDR photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_hidden">
<span class="sig-name descname"><span class="pre">not_hidden</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_hidden" title="Link to this definition">¶</a></dt>
<dd><p>search for non-hidden photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_in_album">
<span class="sig-name descname"><span class="pre">not_in_album</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_in_album" title="Link to this definition">¶</a></dt>
<dd><p>search for photos not in an album</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_incloud">
<span class="sig-name descname"><span class="pre">not_incloud</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_incloud" title="Link to this definition">¶</a></dt>
<dd><p>search for cloud asset photos that are not yet synched to iCloud</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_live">
<span class="sig-name descname"><span class="pre">not_live</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_live" title="Link to this definition">¶</a></dt>
<dd><p>search for non-live photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_missing">
<span class="sig-name descname"><span class="pre">not_missing</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_missing" title="Link to this definition">¶</a></dt>
<dd><p>search for non-missing photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_panorama">
<span class="sig-name descname"><span class="pre">not_panorama</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_panorama" title="Link to this definition">¶</a></dt>
<dd><p>search for non-panorama photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_portrait">
<span class="sig-name descname"><span class="pre">not_portrait</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_portrait" title="Link to this definition">¶</a></dt>
<dd><p>search for non-portrait photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_reference">
<span class="sig-name descname"><span class="pre">not_reference</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_reference" title="Link to this definition">¶</a></dt>
<dd><p>search for photos not stored by reference (that is, they are managed by Photos)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_screenshot">
<span class="sig-name descname"><span class="pre">not_screenshot</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_screenshot" title="Link to this definition">¶</a></dt>
<dd><p>search for non-screenshot photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_screen_recording">
<span class="sig-name descname"><span class="pre">not_screen_recording</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_screen_recording" title="Link to this definition">¶</a></dt>
<dd><p>search for non-screen recordings videos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_selfie">
<span class="sig-name descname"><span class="pre">not_selfie</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_selfie" title="Link to this definition">¶</a></dt>
<dd><p>search for non-selfie photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_shared">
<span class="sig-name descname"><span class="pre">not_shared</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_shared" title="Link to this definition">¶</a></dt>
<dd><p>search for non-shared photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_slow_mo">
<span class="sig-name descname"><span class="pre">not_slow_mo</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_slow_mo" title="Link to this definition">¶</a></dt>
<dd><p>search for non-slow-mo photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_time_lapse">
<span class="sig-name descname"><span class="pre">not_time_lapse</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_time_lapse" title="Link to this definition">¶</a></dt>
<dd><p>search for non-time-lapse photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.panorama">
<span class="sig-name descname"><span class="pre">panorama</span></span><a class="headerlink" href="#osxphotos.QueryOptions.panorama" title="Link to this definition">¶</a></dt>
<dd><p>search for panorama photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.person">
<span class="sig-name descname"><span class="pre">person</span></span><a class="headerlink" href="#osxphotos.QueryOptions.person" title="Link to this definition">¶</a></dt>
<dd><p>list of person names to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.photos">
<span class="sig-name descname"><span class="pre">photos</span></span><a class="headerlink" href="#osxphotos.QueryOptions.photos" title="Link to this definition">¶</a></dt>
<dd><p>search for photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.place">
<span class="sig-name descname"><span class="pre">place</span></span><a class="headerlink" href="#osxphotos.QueryOptions.place" title="Link to this definition">¶</a></dt>
<dd><p>list of place names to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.portrait">
<span class="sig-name descname"><span class="pre">portrait</span></span><a class="headerlink" href="#osxphotos.QueryOptions.portrait" title="Link to this definition">¶</a></dt>
<dd><p>search for portrait photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.query_eval">
<span class="sig-name descname"><span class="pre">query_eval</span></span><a class="headerlink" href="#osxphotos.QueryOptions.query_eval" title="Link to this definition">¶</a></dt>
<dd><p>list of query expressions to evaluate</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.regex">
<span class="sig-name descname"><span class="pre">regex</span></span><a class="headerlink" href="#osxphotos.QueryOptions.regex" title="Link to this definition">¶</a></dt>
<dd><p>list of regular expressions to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[Tuple[str, str]]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.screenshot">
<span class="sig-name descname"><span class="pre">screenshot</span></span><a class="headerlink" href="#osxphotos.QueryOptions.screenshot" title="Link to this definition">¶</a></dt>
<dd><p>search for screenshot photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.screen_recording">
<span class="sig-name descname"><span class="pre">screen_recording</span></span><a class="headerlink" href="#osxphotos.QueryOptions.screen_recording" title="Link to this definition">¶</a></dt>
<dd><p>search for screen recording videos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.selected">
<span class="sig-name descname"><span class="pre">selected</span></span><a class="headerlink" href="#osxphotos.QueryOptions.selected" title="Link to this definition">¶</a></dt>
<dd><p>search for selected photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.selfie">
<span class="sig-name descname"><span class="pre">selfie</span></span><a class="headerlink" href="#osxphotos.QueryOptions.selfie" title="Link to this definition">¶</a></dt>
<dd><p>search for selfie photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.shared">
<span class="sig-name descname"><span class="pre">shared</span></span><a class="headerlink" href="#osxphotos.QueryOptions.shared" title="Link to this definition">¶</a></dt>
<dd><p>search for shared photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.slow_mo">
<span class="sig-name descname"><span class="pre">slow_mo</span></span><a class="headerlink" href="#osxphotos.QueryOptions.slow_mo" title="Link to this definition">¶</a></dt>
<dd><p>search for slow-mo photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.time_lapse">
<span class="sig-name descname"><span class="pre">time_lapse</span></span><a class="headerlink" href="#osxphotos.QueryOptions.time_lapse" title="Link to this definition">¶</a></dt>
<dd><p>search for time-lapse photos</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.title">
<span class="sig-name descname"><span class="pre">title</span></span><a class="headerlink" href="#osxphotos.QueryOptions.title" title="Link to this definition">¶</a></dt>
<dd><p>list of titles to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.to_date">
<span class="sig-name descname"><span class="pre">to_date</span></span><a class="headerlink" href="#osxphotos.QueryOptions.to_date" title="Link to this definition">¶</a></dt>
<dd><p>search for photos taken before this date</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[datetime.datetime]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.to_time">
<span class="sig-name descname"><span class="pre">to_time</span></span><a class="headerlink" href="#osxphotos.QueryOptions.to_time" title="Link to this definition">¶</a></dt>
<dd><p>search for photos taken before this time of day</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[datetime.time]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.uti">
<span class="sig-name descname"><span class="pre">uti</span></span><a class="headerlink" href="#osxphotos.QueryOptions.uti" title="Link to this definition">¶</a></dt>
<dd><p>list of UTIs to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.uuid">
<span class="sig-name descname"><span class="pre">uuid</span></span><a class="headerlink" href="#osxphotos.QueryOptions.uuid" title="Link to this definition">¶</a></dt>
<dd><p>list of uuids to search for</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[str]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.year">
<span class="sig-name descname"><span class="pre">year</span></span><a class="headerlink" href="#osxphotos.QueryOptions.year" title="Link to this definition">¶</a></dt>
<dd><p>search for photos taken in a given year</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[Iterable[int]]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.syndicated">
<span class="sig-name descname"><span class="pre">syndicated</span></span><a class="headerlink" href="#osxphotos.QueryOptions.syndicated" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that have been shared via syndication (&quot;Shared with You&quot; album via Messages, etc.)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_syndicated">
<span class="sig-name descname"><span class="pre">not_syndicated</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_syndicated" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that have not been shared via syndication (&quot;Shared with You&quot; album via Messages, etc.)</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.saved_to_library">
<span class="sig-name descname"><span class="pre">saved_to_library</span></span><a class="headerlink" href="#osxphotos.QueryOptions.saved_to_library" title="Link to this definition">¶</a></dt>
<dd><p>search for syndicated photos that have been saved to the Photos library</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_saved_to_library">
<span class="sig-name descname"><span class="pre">not_saved_to_library</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_saved_to_library" title="Link to this definition">¶</a></dt>
<dd><p>search for syndicated photos that have not been saved to the Photos library</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.shared_moment">
<span class="sig-name descname"><span class="pre">shared_moment</span></span><a class="headerlink" href="#osxphotos.QueryOptions.shared_moment" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that have been shared via a shared moment</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_shared_moment">
<span class="sig-name descname"><span class="pre">not_shared_moment</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_shared_moment" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that have not been shared via a shared moment</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.shared_library">
<span class="sig-name descname"><span class="pre">shared_library</span></span><a class="headerlink" href="#osxphotos.QueryOptions.shared_library" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that are part of a shared iCloud library</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="osxphotos.QueryOptions.not_shared_library">
<span class="sig-name descname"><span class="pre">not_shared_library</span></span><a class="headerlink" href="#osxphotos.QueryOptions.not_shared_library" title="Link to this definition">¶</a></dt>
<dd><p>search for photos that are not part of a shared iCloud library</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[bool]</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.ScoreInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">ScoreInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">overall</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">curation</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">promotion</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">highlight_visibility</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">behavioral</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">failure</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">harmonious_color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">immersiveness</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interaction</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interesting_subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intrusive_object_presence</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lively_color</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">low_light</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">noise</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_camera_tilt</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_composition</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_lighting</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_pattern</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_perspective</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_post_processing</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_reflection</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pleasant_symmetry</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sharply_focused_subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tastefully_blurred</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">well_chosen_subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">well_framed_subject</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">well_timed_shot</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/scoreinfo.html#ScoreInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ScoreInfo" title="Link to this definition">¶</a></dt>
<dd><p>Computed photo score info associated with a photo from the Photos library</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.ScoreInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/scoreinfo.html#ScoreInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.ScoreInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return ScoreInfo as a dict</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.SearchInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">SearchInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">normalized</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/searchinfo.html#SearchInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.SearchInfo" title="Link to this definition">¶</a></dt>
<dd><p>Info about search terms such as machine learning labels that Photos knows about a photo</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.activities">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">activities</span></span><a class="headerlink" href="#osxphotos.SearchInfo.activities" title="Link to this definition">¶</a></dt>
<dd><p>returns list of activity names</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.all">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">all</span></span><a class="headerlink" href="#osxphotos.SearchInfo.all" title="Link to this definition">¶</a></dt>
<dd><p>return all search info properties in a single list</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/searchinfo.html#SearchInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.SearchInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>return dict of search info</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.bodies_of_water">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">bodies_of_water</span></span><a class="headerlink" href="#osxphotos.SearchInfo.bodies_of_water" title="Link to this definition">¶</a></dt>
<dd><p>returns list of body of water names</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.camera">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">camera</span></span><a class="headerlink" href="#osxphotos.SearchInfo.camera" title="Link to this definition">¶</a></dt>
<dd><p>returns camera name (macOS 13+ / Photos 8+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.city">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">city</span></span><a class="headerlink" href="#osxphotos.SearchInfo.city" title="Link to this definition">¶</a></dt>
<dd><p>returns city/town</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.country">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">country</span></span><a class="headerlink" href="#osxphotos.SearchInfo.country" title="Link to this definition">¶</a></dt>
<dd><p>returns country name</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.detected_text">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">detected_text</span></span><a class="headerlink" href="#osxphotos.SearchInfo.detected_text" title="Link to this definition">¶</a></dt>
<dd><p>Returns text detected in the photo (macOS 13+ / Photos 8+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.holidays">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">holidays</span></span><a class="headerlink" href="#osxphotos.SearchInfo.holidays" title="Link to this definition">¶</a></dt>
<dd><p>returns list of holiday names</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.labels">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">labels</span></span><a class="headerlink" href="#osxphotos.SearchInfo.labels" title="Link to this definition">¶</a></dt>
<dd><p>return list of labels associated with Photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.locality_names">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">locality_names</span></span><a class="headerlink" href="#osxphotos.SearchInfo.locality_names" title="Link to this definition">¶</a></dt>
<dd><p>returns list of other locality names</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.media_types">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media_types</span></span><a class="headerlink" href="#osxphotos.SearchInfo.media_types" title="Link to this definition">¶</a></dt>
<dd><p>returns list of media types (photo, video, panorama, etc)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.month">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">month</span></span><a class="headerlink" href="#osxphotos.SearchInfo.month" title="Link to this definition">¶</a></dt>
<dd><p>returns month name</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.neighborhoods">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">neighborhoods</span></span><a class="headerlink" href="#osxphotos.SearchInfo.neighborhoods" title="Link to this definition">¶</a></dt>
<dd><p>returns list of neighborhoods</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.place_names">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">place_names</span></span><a class="headerlink" href="#osxphotos.SearchInfo.place_names" title="Link to this definition">¶</a></dt>
<dd><p>returns list of place names</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.season">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">season</span></span><a class="headerlink" href="#osxphotos.SearchInfo.season" title="Link to this definition">¶</a></dt>
<dd><p>returns season name</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.source">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">source</span></span><a class="headerlink" href="#osxphotos.SearchInfo.source" title="Link to this definition">¶</a></dt>
<dd><p>returns source of the photo (e.g. &quot;Messages&quot;, &quot;Safar&quot;, etc) (macOS 13+ / Photos 8+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.state">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state</span></span><a class="headerlink" href="#osxphotos.SearchInfo.state" title="Link to this definition">¶</a></dt>
<dd><p>returns state name</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.state_abbreviation">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">state_abbreviation</span></span><a class="headerlink" href="#osxphotos.SearchInfo.state_abbreviation" title="Link to this definition">¶</a></dt>
<dd><p>returns state abbreviation</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.streets">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">streets</span></span><a class="headerlink" href="#osxphotos.SearchInfo.streets" title="Link to this definition">¶</a></dt>
<dd><p>returns list of street names</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.text_found">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">text_found</span></span><a class="headerlink" href="#osxphotos.SearchInfo.text_found" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photos has detected text (macOS 13+ / Photos 8+ only)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.venue_types">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">venue_types</span></span><a class="headerlink" href="#osxphotos.SearchInfo.venue_types" title="Link to this definition">¶</a></dt>
<dd><p>returns list of venue types</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.venues">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">venues</span></span><a class="headerlink" href="#osxphotos.SearchInfo.venues" title="Link to this definition">¶</a></dt>
<dd><p>returns list of venue names</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.SearchInfo.year">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">year</span></span><a class="headerlink" href="#osxphotos.SearchInfo.year" title="Link to this definition">¶</a></dt>
<dd><p>returns year</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.SidecarWriter">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">SidecarWriter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.PhotoInfo"><span class="pre">PhotoInfo</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/sidecars.html#SidecarWriter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.SidecarWriter" title="Link to this definition">¶</a></dt>
<dd><p>Write sidecars for PhotoInfo objects</p>
<p>Can write XMP, JSON, and exiftool sidecars</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>photo</strong> -- PhotoInfo object</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Sidecars are written by calling write_sidecar_files() which returns an ExportResults object</p>
</div>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.SidecarWriter.write_sidecar_files">
<span class="sig-name descname"><span class="pre">write_sidecar_files</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportOptions" title="osxphotos.exportoptions.ExportOptions"><span class="pre">ExportOptions</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_results</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportResults" title="osxphotos.exportoptions.ExportResults"><span class="pre">ExportResults</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#osxphotos.ExportResults" title="osxphotos.exportoptions.ExportResults"><span class="pre">ExportResults</span></a></span></span><a class="reference internal" href="_modules/osxphotos/sidecars.html#SidecarWriter.write_sidecar_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.SidecarWriter.write_sidecar_files" title="Link to this definition">¶</a></dt>
<dd><p>Write sidecar files for the photo.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dest</strong> -- destination path for photo that sidecars are being written for</p></li>
<li><p><strong>options</strong> -- ExportOptions object that configures the sidecars</p></li>
<li><p><strong>export_results</strong> -- ExportResults object containing information about the exported photo</p></li>
</ul>
</dd>
</dl>
<p>Returns: An ExportResults object containing information about the exported sidecar files</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>dest is the path to the the sidecar belongs to. THe sidecar filename will be
dest.ext where ext is the extension for sidecar (e.g. xmp or json)
If dest is &quot;img_1234.jpg&quot;, XMP sidecar would be &quot;img_1234.jpg.xmp&quot;
Use ExportOptions(sidecar_drop_ext) to drop the image extension from the sidecar filename
(e.g. &quot;img_1234.xmp&quot;)</p>
</div>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.SidecarWriter.write_user_sidecar_files">
<span class="sig-name descname"><span class="pre">write_user_sidecar_files</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Path</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportOptions" title="osxphotos.exportoptions.ExportOptions"><span class="pre">ExportOptions</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_results</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportResults" title="osxphotos.exportoptions.ExportResults"><span class="pre">ExportResults</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#osxphotos.ExportResults" title="osxphotos.exportoptions.ExportResults"><span class="pre">ExportResults</span></a></span></span><a class="reference internal" href="_modules/osxphotos/sidecars.html#SidecarWriter.write_user_sidecar_files"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.SidecarWriter.write_user_sidecar_files" title="Link to this definition">¶</a></dt>
<dd><p>Write user sidecar files for the photo.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dest</strong> -- destination path for photo that sidecars are being written for</p></li>
<li><p><strong>options</strong> -- ExportOptions object that configures the sidecars</p></li>
<li><p><strong>export_results</strong> -- ExportResults object with information about the exorted photos</p></li>
</ul>
</dd>
</dl>
<p>Returns: An ExportResults object containing information about the exported sidecar files</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.SidecarWriter.xmp_sidecar">
<span class="sig-name descname"><span class="pre">xmp_sidecar</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.ExportOptions" title="osxphotos.exportoptions.ExportOptions"><span class="pre">ExportOptions</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extension</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/sidecars.html#SidecarWriter.xmp_sidecar"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.SidecarWriter.xmp_sidecar" title="Link to this definition">¶</a></dt>
<dd><p>returns string for XMP sidecar</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>options</strong> (<a class="reference internal" href="#osxphotos.ExportOptions" title="osxphotos.ExportOptions"><em>ExportOptions</em></a>) -- options for export</p></li>
<li><p><strong>extension</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) -- which extension to use for SidecarForExtension property</p></li>
</ul>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">iPhotoAlbumInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">album</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.iPhotoDB" title="osxphotos.iphoto.iPhotoDB"><span class="pre">iPhotoDB</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoAlbumInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo" title="Link to this definition">¶</a></dt>
<dd><p>AlbumInfo class for iPhoto</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoAlbumInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return album info as a dict; does not include photos</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.folder_list">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_list</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoFolderInfo" title="osxphotos.iphoto.iPhotoFolderInfo"><span class="pre">iPhotoFolderInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.folder_list" title="Link to this definition">¶</a></dt>
<dd><p>Returns hierachical list of iPhotoFolderInfo objects for each folder the album is contained in
or empty list if album is not in any folders</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.folder_names">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">folder_names</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.folder_names" title="Link to this definition">¶</a></dt>
<dd><p>Return hierarchical list of folders the album is contained in
the folder list is in form:
[&quot;Top level folder&quot;, &quot;sub folder 1&quot;, &quot;sub folder 2&quot;, ...]
or empty list if album is not in any folders</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoAlbumInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.json" title="Link to this definition">¶</a></dt>
<dd><p>JSON representation of album</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.parent">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.iPhotoFolderInfo" title="osxphotos.iphoto.iPhotoFolderInfo"><span class="pre">iPhotoFolderInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.parent" title="Link to this definition">¶</a></dt>
<dd><p>returns iPhotoFolderInfo object for parent folder or None if no parent (e.g. top-level album)</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.photo_index">
<span class="sig-name descname"><span class="pre">photo_index</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo" title="osxphotos.iphoto.iPhotoPhotoInfo"><span class="pre">iPhotoPhotoInfo</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoAlbumInfo.photo_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.photo_index" title="Link to this definition">¶</a></dt>
<dd><p>Return index of photo in album; not implemented, always 0</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.photos">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo" title="osxphotos.iphoto.iPhotoPhotoInfo"><span class="pre">iPhotoPhotoInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.photos" title="Link to this definition">¶</a></dt>
<dd><p>Return list of photos contained in the album</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.sort_order">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sort_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.sort_order" title="Link to this definition">¶</a></dt>
<dd><p>Return sort order; not implemented, always 0</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.title">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.title" title="Link to this definition">¶</a></dt>
<dd><p>Title of album</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoAlbumInfo.uuid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uuid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoAlbumInfo.uuid" title="Link to this definition">¶</a></dt>
<dd><p>UUID of album</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">iPhotoDB</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dbfile</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">...</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rich</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_skip_searchinfo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoDB"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoDB" title="Link to this definition">¶</a></dt>
<dd><p>Read an iPhoto library database; interface matches osxphotos.PhotosDB</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.album_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">album_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo" title="osxphotos.iphoto.iPhotoAlbumInfo"><span class="pre">iPhotoAlbumInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoDB.album_info" title="Link to this definition">¶</a></dt>
<dd><p>Return list of iPhotoAlbumInfo objects for each album in the library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.albums">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">albums</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoDB.albums" title="Link to this definition">¶</a></dt>
<dd><p>Return list of album names</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.albums_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">albums_as_dict</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoDB.albums_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>Return albums as dict of list of albums keyed by count of photos</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.db_version">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">db_version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoDB.db_version"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoDB.db_version" title="Link to this definition">¶</a></dt>
<dd><p>Return the database version as stored in Library.apdb RKAdminData table</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.get_db_connection">
<span class="sig-name descname"><span class="pre">get_db_connection</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">Connection</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Cursor</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoDB.get_db_connection"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoDB.get_db_connection" title="Link to this definition">¶</a></dt>
<dd><p>Get connection to the working copy of the Photos database</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple of (connection, cursor) to sqlite3 database</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>NotImplementedError on iPhoto</strong> -- </p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.get_photo">
<span class="sig-name descname"><span class="pre">get_photo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo" title="osxphotos.iphoto.iPhotoPhotoInfo"><span class="pre">iPhotoPhotoInfo</span></a></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoDB.get_photo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoDB.get_photo" title="Link to this definition">¶</a></dt>
<dd><p>Return photo by uuid</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.keywords_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keywords_as_dict</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoDB.keywords_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>Return keywords as dict of list of keywords keyed by count of photos</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.persons_as_dict">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">persons_as_dict</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoDB.persons_as_dict" title="Link to this definition">¶</a></dt>
<dd><p>Return persons as dict of list of persons keyed count of photos</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.photos">
<span class="sig-name descname"><span class="pre">photos</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">persons</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">albums</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">images</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">movies</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">from_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_date</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">datetime</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">intrash</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo" title="osxphotos.iphoto.iPhotoPhotoInfo"><span class="pre">iPhotoPhotoInfo</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoDB.photos"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoDB.photos" title="Link to this definition">¶</a></dt>
<dd><p>Return a list of iPhotoPhotoInfo objects
If called with no args, returns the entire database of photos
If called with args, returns photos matching the args (e.g. keywords, persons, etc.)
If more than one arg, returns photos matching all the criteria (e.g. keywords AND persons)
If more than one keyword, uuid, persons, albums is passed, they are treated as &quot;OR&quot; criteria
e.g. keywords=[&quot;wedding&quot;,&quot;vacation&quot;] returns photos matching either keyword
from_date and to_date may be either naive or timezone-aware datetime.datetime objects.
If naive, timezone will be assumed to be local timezone.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>keywords</strong> -- list of keywords to search for</p></li>
<li><p><strong>uuid</strong> -- list of UUIDs to search for</p></li>
<li><p><strong>persons</strong> -- list of persons to search for</p></li>
<li><p><strong>albums</strong> -- list of album names to search for</p></li>
<li><p><strong>images</strong> -- if True, returns image files, if False, does not return images; default is True</p></li>
<li><p><strong>movies</strong> -- if True, returns movie files, if False, does not return movies; default is True</p></li>
<li><p><strong>from_date</strong> -- return photos with creation date &gt;= from_date (datetime.datetime object, default None)</p></li>
<li><p><strong>to_date</strong> -- return photos with creation date &lt; to_date (datetime.datetime object, default None)</p></li>
<li><p><strong>intrash</strong> -- if True, returns only images in &quot;Recently deleted items&quot; folder,
if False returns only photos that aren't deleted; default is False</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of iPhotoPhotoInfo objects</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.photos_version">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos_version</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoDB.photos_version"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoDB.photos_version" title="Link to this definition">¶</a></dt>
<dd><p>Returns version of the library as a string</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoDB.query">
<span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.QueryOptions" title="osxphotos.photoquery.QueryOptions"><span class="pre">QueryOptions</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo" title="osxphotos.iphoto.iPhotoPhotoInfo"><span class="pre">iPhotoPhotoInfo</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoDB.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoDB.query" title="Link to this definition">¶</a></dt>
<dd><p>Run a query against PhotosDB to extract the photos based on user supplied options</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>options</strong> -- a QueryOptions instance</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">iPhotoFaceInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo" title="osxphotos.iphoto.iPhotoPhotoInfo"><span class="pre">iPhotoPhotoInfo</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">face</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.iPhotoDB" title="osxphotos.iphoto.iPhotoDB"><span class="pre">iPhotoDB</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoFaceInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoFaceInfo" title="Link to this definition">¶</a></dt>
<dd><p>FaceInfo implementation for iPhoto</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoFaceInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Returns dict representation of class instance</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.center">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">center</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.center" title="Link to this definition">¶</a></dt>
<dd><p>Coordinates, in PIL format, for center of face</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>tuple of coordinates in form (x, y)</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.center_x">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">center_x</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.center_x" title="Link to this definition">¶</a></dt>
<dd><p>X coordinate for center of face as percent of width</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.center_y">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">center_y</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.center_y" title="Link to this definition">¶</a></dt>
<dd><p>Y coordinate for center of face as percent of height</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.face_rect">
<span class="sig-name descname"><span class="pre">face_rect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">int</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoFaceInfo.face_rect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.face_rect" title="Link to this definition">¶</a></dt>
<dd><dl class="simple">
<dt>Get face rectangle coordinates for current version of the associated image</dt><dd><p>If image has been edited, rectangle applies to edited version, otherwise original version
Coordinates in format and reference frame used by PIL</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list [(x0, x1), (y0, y1)] of coordinates in reference frame used by PIL</p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoFaceInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.json" title="Link to this definition">¶</a></dt>
<dd><p>Return JSON representation of iPhotoFaceInfo instance</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.mpri_reg_rect">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mpri_reg_rect</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MPRI_Reg_Rect</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.mpri_reg_rect" title="Link to this definition">¶</a></dt>
<dd><p>Get coordinates for Microsoft Photo Region Rectangle.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>x = x coordinate of top left corner of rectangle
y = y coordinate of top left corner of rectangle
h = height of rectangle
w = width of rectangle</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>MPRI_Reg_Rect named tuple with x, y, h, w where</p>
</dd>
</dl>
<dl class="simple">
<dt>Reference:</dt><dd><p><a class="reference external" href="https://docs.microsoft.com/en-us/windows/win32/wic/-wic-people-tagging">https://docs.microsoft.com/en-us/windows/win32/wic/-wic-people-tagging</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.mwg_rs_area">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">mwg_rs_area</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">MWG_RS_Area</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.mwg_rs_area" title="Link to this definition">¶</a></dt>
<dd><p>Get coordinates for Metadata Working Group Region Area.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>x = stArea:x
y = stArea:y
h = stArea:h
w = stArea:w</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>MWG_RS_Area named tuple with x, y, h, w where</p>
</dd>
</dl>
<dl class="simple">
<dt>Reference:</dt><dd><p><a class="reference external" href="https://photo.stackexchange.com/questions/106410/how-does-xmp-define-the-face-region">https://photo.stackexchange.com/questions/106410/how-does-xmp-define-the-face-region</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.name">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.name" title="Link to this definition">¶</a></dt>
<dd><p>Name of person in the photo or None</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.person_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">person_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.iPhotoPersonInfo" title="osxphotos.iphoto.iPhotoPersonInfo"><span class="pre">iPhotoPersonInfo</span></a></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.person_info" title="Link to this definition">¶</a></dt>
<dd><p>iPhotoPersonInfo object for face</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.pitch">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">pitch</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.pitch" title="Link to this definition">¶</a></dt>
<dd><p>Return pitch angle in radians of the face region</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.quality">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">quality</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.quality" title="Link to this definition">¶</a></dt>
<dd><p>Quality (confidence) of face detection</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.roll">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">roll</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.roll" title="Link to this definition">¶</a></dt>
<dd><p>Return roll angle in radians of the face region</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.roll_pitch_yaw">
<span class="sig-name descname"><span class="pre">roll_pitch_yaw</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoFaceInfo.roll_pitch_yaw"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.roll_pitch_yaw" title="Link to this definition">¶</a></dt>
<dd><p>Roll, pitch, yaw of face in radians as tuple</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.size">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">size</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.size" title="Link to this definition">¶</a></dt>
<dd><p>Size of face as percent of image width</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.size_pixels">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">size_pixels</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.size_pixels" title="Link to this definition">¶</a></dt>
<dd><p>Size of face in pixels (centered around center_x, center_y)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>size, in int pixels, of a circle drawn around the center of the face</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFaceInfo.yaw">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">yaw</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span></em><a class="headerlink" href="#osxphotos.iPhotoFaceInfo.yaw" title="Link to this definition">¶</a></dt>
<dd><p>Return yaw angle in radians of the face region</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.iPhotoFolderInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">iPhotoFolderInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">folder</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.iPhotoDB" title="osxphotos.iphoto.iPhotoDB"><span class="pre">iPhotoDB</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoFolderInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoFolderInfo" title="Link to this definition">¶</a></dt>
<dd><p>Info about a specific folder, contains all the details about the folder
including folders, albums, etc</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFolderInfo.album_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">album_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo" title="osxphotos.iphoto.iPhotoAlbumInfo"><span class="pre">iPhotoAlbumInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoFolderInfo.album_info" title="Link to this definition">¶</a></dt>
<dd><p>Return list of albums (as iPhotoAlbumInfo objects) contained in the folder</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoFolderInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoFolderInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoFolderInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return folder info as a dict</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoFolderInfo.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoFolderInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoFolderInfo.json" title="Link to this definition">¶</a></dt>
<dd><p>Return folder info as json</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFolderInfo.parent">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parent</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.iPhotoFolderInfo" title="osxphotos.iphoto.iPhotoFolderInfo"><span class="pre">iPhotoFolderInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoFolderInfo.parent" title="Link to this definition">¶</a></dt>
<dd><p>Return iPhotoFolderInfo object for parent or None if no parent (e.g. top-level folder)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFolderInfo.subfolders">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">subfolders</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoFolderInfo" title="osxphotos.iphoto.iPhotoFolderInfo"><span class="pre">iPhotoFolderInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoFolderInfo.subfolders" title="Link to this definition">¶</a></dt>
<dd><p>Return list of folders (as FolderInfo objects) contained in the folder</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFolderInfo.title">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoFolderInfo.title" title="Link to this definition">¶</a></dt>
<dd><p>Title of folder</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoFolderInfo.uuid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uuid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoFolderInfo.uuid" title="Link to this definition">¶</a></dt>
<dd><p>UUID of folder</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">iPhotoPersonInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">face</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.iPhotoDB" title="osxphotos.iphoto.iPhotoDB"><span class="pre">iPhotoDB</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPersonInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPersonInfo" title="Link to this definition">¶</a></dt>
<dd><p>PersonInfo implementation for iPhoto</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPersonInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return person as dict</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.facecount">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">facecount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.facecount" title="Link to this definition">¶</a></dt>
<dd><p>Count of faces for person</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.favorite">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorite</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.favorite" title="Link to this definition">¶</a></dt>
<dd><p>Returns False for iPhoto</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.feature_less">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">feature_less</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.feature_less" title="Link to this definition">¶</a></dt>
<dd><p>Always returns False for iPhoto</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPersonInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.json" title="Link to this definition">¶</a></dt>
<dd><p>Return person as json</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.keyface">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keyface</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.iPhotoFaceInfo" title="osxphotos.iphoto.iPhotoFaceInfo"><span class="pre">iPhotoFaceInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.keyface" title="Link to this definition">¶</a></dt>
<dd><p>Key face for person</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.keyphoto">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keyphoto</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo" title="osxphotos.iphoto.iPhotoPhotoInfo"><span class="pre">iPhotoPhotoInfo</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.keyphoto" title="Link to this definition">¶</a></dt>
<dd><p>Key photo for person</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.name">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.name" title="Link to this definition">¶</a></dt>
<dd><p>Name of person</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.photos">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">photos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo" title="osxphotos.iphoto.iPhotoPhotoInfo"><span class="pre">iPhotoPhotoInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.photos" title="Link to this definition">¶</a></dt>
<dd><p>List of photos face is contained in</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.sort_order">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sort_order</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.sort_order" title="Link to this definition">¶</a></dt>
<dd><p>Always returns 0 for iPhoto</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPersonInfo.uuid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uuid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoPersonInfo.uuid" title="Link to this definition">¶</a></dt>
<dd><p>UUID of person</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">iPhotoPhotoInfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uuid</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">db</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#osxphotos.iPhotoDB" title="osxphotos.iphoto.iPhotoDB"><span class="pre">iPhotoDB</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo" title="Link to this definition">¶</a></dt>
<dd><p>PhotoInfo implementation for iPhoto</p>
<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.ai_caption">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ai_caption</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.ai_caption" title="Link to this definition">¶</a></dt>
<dd><p>Returns AI generated caption for photo or video (Photos 5+)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.album_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">album_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo" title="osxphotos.iphoto.iPhotoAlbumInfo"><span class="pre">iPhotoAlbumInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.album_info" title="Link to this definition">¶</a></dt>
<dd><p>&quot;Return list of iPhotoAlbumInfo objects for photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.albums">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">albums</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.albums" title="Link to this definition">¶</a></dt>
<dd><p>List of albums photo is contained in</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.asdict">
<span class="sig-name descname"><span class="pre">asdict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">shallow</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo.asdict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.asdict" title="Link to this definition">¶</a></dt>
<dd><p>Return dict representation of iPhotoPhotoInfo object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>shallow</strong> -- if True, return shallow representation (does not contain folder_info, person_info, etc.)</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>dict representation of iPhotoPhotoInfo object</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The shallow representation is used internally by export as it contains only the subset of data needed for export.</p>
</div>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.burst">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.burst" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is part of a Burst photo set, otherwise False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.burst_album_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_album_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo" title="osxphotos.iphoto.iPhotoAlbumInfo"><span class="pre">iPhotoAlbumInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.burst_album_info" title="Link to this definition">¶</a></dt>
<dd><p>For iPhoto, returns self.album_info; this is different behavior than Photos</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.burst_albums">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_albums</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.burst_albums" title="Link to this definition">¶</a></dt>
<dd><p>For iPhoto, returns self.albums; this is different behavior than Photos</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.burst_photos">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">burst_photos</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.PhotoInfo"><span class="pre">PhotoInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.burst_photos" title="Link to this definition">¶</a></dt>
<dd><p>If photo is a burst photo, returns list of iPhotoPhotoInfo objects
that are part of the same burst photo set; otherwise returns empty list.
self is not included in the returned list</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.date">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.date" title="Link to this definition">¶</a></dt>
<dd><p>Date photo was taken</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.date_added">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_added</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.date_added" title="Link to this definition">¶</a></dt>
<dd><p>Date added to library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.date_modified">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_modified</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.date_modified" title="Link to this definition">¶</a></dt>
<dd><p>Date modified in library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.date_original">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">date_original</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">datetime</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.date_original" title="Link to this definition">¶</a></dt>
<dd><p>Date photo was taken</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.description">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">description</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.description" title="Link to this definition">¶</a></dt>
<dd><p>Description of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.event_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">event_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">iPhotoEventInfo</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.event_info" title="Link to this definition">¶</a></dt>
<dd><p>Return iPhotoEventInfo object for photo or None if photo is not in an event</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.exif_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">exif_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">iPhotoExifInfo</span></em><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo.exif_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.exif_info" title="Link to this definition">¶</a></dt>
<dd><p>Return iPhotoExifInfo object for photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.exiftool">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">exiftool</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ExifToolCaching</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo.exiftool"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.exiftool" title="Link to this definition">¶</a></dt>
<dd><p>Returns a ExifToolCaching (read-only instance of ExifTool) object for the photo.
Requires that exiftool (<a class="reference external" href="https://exiftool.org/">https://exiftool.org/</a>) be installed
If exiftool not installed, logs warning and returns None
If photo path is missing, returns None</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.export">
<span class="sig-name descname"><span class="pre">export</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dest</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">edited</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raw_photo</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">export_as_hardlink</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">overwrite</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">increment</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_json</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_exiftool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sidecar_xmp</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">exiftool</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_albums_as_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">use_persons_as_keywords</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keyword_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description_template</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">render_options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RenderOptions</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo.export"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.export" title="Link to this definition">¶</a></dt>
<dd><p>Export a photo</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dest</strong> -- must be valid destination path (or exception raised)</p></li>
<li><p><strong>filename</strong> -- (optional): name of exported picture; if not provided, will use current filename
<strong>NOTE</strong>: if provided, user must ensure file extension (suffix) is correct.
For example, if photo is .CR2 file, edited image may be .jpeg.
If you provide an extension different than what the actual file is,
export will print a warning but will export the photo using the
incorrect file extension (unless use_photos_export is true, in which case export will
use the extension provided by Photos upon export; in this case, an incorrect extension is
silently ignored).
e.g. to get the extension of the edited photo,
reference iPhotoPhotoInfo.path_edited</p></li>
<li><p><strong>edited</strong> -- (boolean, default=False); if True will export the edited version of the photo, otherwise exports the original version
(or raise exception if no edited version)</p></li>
<li><p><strong>raw_photo</strong> -- (boolean, default=False); if True, will also export the associated RAW photo</p></li>
<li><p><strong>export_as_hardlink</strong> -- (boolean, default=False); if True, will hardlink files instead of copying them</p></li>
<li><p><strong>overwrite</strong> -- (boolean, default=False); if True will overwrite files if they already exist</p></li>
<li><p><strong>increment</strong> -- (boolean, default=True); if True, will increment file name until a non-existant name is found
if overwrite=False and increment=False, export will fail if destination file already exists</p></li>
<li><p><strong>sidecar_json</strong> -- if set will write a json sidecar with data in format readable by exiftool
sidecar filename will be dest/filename.json; includes exiftool tag group names (e.g. 'exiftool -G -j')</p></li>
<li><p><strong>sidecar_exiftool</strong> -- if set will write a json sidecar with data in format readable by exiftool
sidecar filename will be dest/filename.json; does not include exiftool tag group names (e.g. 'exiftool -j')</p></li>
<li><p><strong>sidecar_xmp</strong> -- if set will write an XMP sidecar with IPTC data
sidecar filename will be dest/filename.xmp</p></li>
<li><p><strong>exiftool</strong> -- (boolean, default = False); if True, will use exiftool to write metadata to export file</p></li>
<li><p><strong>files</strong> (<em>returns list</em><em> of </em><em>full paths to the exported</em>)</p></li>
<li><p><strong>use_albums_as_keywords</strong> -- (boolean, default = False); if True, will include album names in keywords</p></li>
<li><p><strong>sidecar</strong> (<em>when exporting metadata with exiftool or</em>)</p></li>
<li><p><strong>use_persons_as_keywords</strong> -- (boolean, default = False); if True, will include person names in keywords</p></li>
<li><p><strong>sidecar</strong></p></li>
<li><p><strong>keyword_template</strong> -- (list of strings); list of template strings that will be rendered as used as keywords</p></li>
<li><p><strong>description_template</strong> -- string; optional template string that will be rendered for use as photo description</p></li>
<li><p><strong>render_options</strong> -- an optional osxphotos.phototemplate.RenderOptions instance with options to pass to template renderer</p></li>
</ul>
</dd>
</dl>
<p>Returns: list of paths to photos exported</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.face_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">face_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoFaceInfo" title="osxphotos.iphoto.iPhotoFaceInfo"><span class="pre">iPhotoFaceInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.face_info" title="Link to this definition">¶</a></dt>
<dd><p>List of iPhotoFaceInfo objects for photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.favorite">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">favorite</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.favorite" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is favorite; iPhoto doesn't have favorite so always returns False</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.filename">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.filename" title="Link to this definition">¶</a></dt>
<dd><p>Filename of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.fingerprint">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">fingerprint</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo.fingerprint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.fingerprint" title="Link to this definition">¶</a></dt>
<dd><p>Returns fingerprint of original photo as a string; returns None if not available. On linux, returns None.</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.flagged">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">flagged</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.flagged" title="Link to this definition">¶</a></dt>
<dd><p>Returns True if photo is flagged</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.hasadjustments">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hasadjustments</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.hasadjustments" title="Link to this definition">¶</a></dt>
<dd><p>True if photo has adjustments</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.height">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">height</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.height" title="Link to this definition">¶</a></dt>
<dd><p>Height of photo in pixels</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.hexdigest">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hexdigest</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo.hexdigest"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.hexdigest" title="Link to this definition">¶</a></dt>
<dd><p>Returns a unique digest of the photo's properties and metadata;
useful for detecting changes in any property/metadata of the photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.hidden">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">hidden</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.hidden" title="Link to this definition">¶</a></dt>
<dd><p>True if photo is hidden</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.intrash">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">intrash</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.intrash" title="Link to this definition">¶</a></dt>
<dd><p>True if photo is in the Photos trash</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.ismissing">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ismissing</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.ismissing" title="Link to this definition">¶</a></dt>
<dd><p>Return True if asset is missing</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.ismovie">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ismovie</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.ismovie" title="Link to this definition">¶</a></dt>
<dd><p>Return True if asset is a movie</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.isphoto">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isphoto</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.isphoto" title="Link to this definition">¶</a></dt>
<dd><p>Return True if asset is a photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.israw">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">israw</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.israw" title="Link to this definition">¶</a></dt>
<dd><p>Return True if asset is a raw image</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.isreference">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">isreference</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.isreference" title="Link to this definition">¶</a></dt>
<dd><p>Return True if asset is a referenced file</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.json">
<span class="sig-name descname"><span class="pre">json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">shallow</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo.json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.json" title="Link to this definition">¶</a></dt>
<dd><p>Return JSON representation</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>indent</strong> -- indent level for JSON, if None, no indent</p></li>
<li><p><strong>shallow</strong> -- if True, return shallow JSON representation (does not contain folder_info, person_info, etc.)</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>JSON string</p>
</dd>
</dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The shallow representation is used internally by export as it contains only the subset of data needed for export.</p>
</div>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.keywords">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">keywords</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.keywords" title="Link to this definition">¶</a></dt>
<dd><p>Keywords for photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.latitude">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">latitude</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.latitude" title="Link to this definition">¶</a></dt>
<dd><p>Latitude of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.location">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">location</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">float</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">float</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.location" title="Link to this definition">¶</a></dt>
<dd><p>Location of photo as (latitude, longitude)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.longitude">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">longitude</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.longitude" title="Link to this definition">¶</a></dt>
<dd><p>Longitude of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.media_analysis">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">media_analysis</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.media_analysis" title="Link to this definition">¶</a></dt>
<dd><p>Returns media analysis results as a dictionary (Photos 5+)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.moment_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">moment_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">iPhotoMomentInfo</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.moment_info" title="Link to this definition">¶</a></dt>
<dd><p>Return iPhotoMomentInfo object for photo or None if photo is not in a moment; for iPhoto returns event as moment</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.orientation">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">orientation</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.orientation" title="Link to this definition">¶</a></dt>
<dd><p>returns EXIF orientation of the current photo version as int or 0 if current orientation cannot be determined</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.original_filename">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_filename</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.original_filename" title="Link to this definition">¶</a></dt>
<dd><p>Original filename of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.original_filesize">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_filesize</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.original_filesize" title="Link to this definition">¶</a></dt>
<dd><p>Size of original file in bytes</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.original_height">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_height</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.original_height" title="Link to this definition">¶</a></dt>
<dd><p>Original height of photo in pixels</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.original_width">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">original_width</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.original_width" title="Link to this definition">¶</a></dt>
<dd><p>Original width of photo in pixels</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.path">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.path" title="Link to this definition">¶</a></dt>
<dd><p>Path to original photo asset in library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.path_derivatives">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path_derivatives</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.path_derivatives" title="Link to this definition">¶</a></dt>
<dd><p>Path to derivatives in library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.path_edited">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">path_edited</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.path_edited" title="Link to this definition">¶</a></dt>
<dd><p>Path to edited asset in library</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.person_info">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">person_info</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.iPhotoPersonInfo" title="osxphotos.iphoto.iPhotoPersonInfo"><span class="pre">iPhotoPersonInfo</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.person_info" title="Link to this definition">¶</a></dt>
<dd><p>List of iPhotoPersonInfo objects for photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.persons">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">persons</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.persons" title="Link to this definition">¶</a></dt>
<dd><p>List of persons in photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.rating">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">rating</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.rating" title="Link to this definition">¶</a></dt>
<dd><p>Rating of photo as int from 0 to 5</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.raw_original">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">raw_original</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.raw_original" title="Link to this definition">¶</a></dt>
<dd><p>Return True if asset original is a raw image</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.render_template">
<span class="sig-name descname"><span class="pre">render_template</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">template_str</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">RenderOptions</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/iphoto.html#iPhotoPhotoInfo.render_template"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.render_template" title="Link to this definition">¶</a></dt>
<dd><p>Renders a template string for iPhotoPhotoInfo instance using PhotoTemplate</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>template_str</strong> -- a template string with fields to render</p></li>
<li><p><strong>options</strong> -- a RenderOptions instance</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>tuple of list of rendered strings and list of unmatched template values</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>([rendered_strings], [unmatched])</p>
</dd>
</dl>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.title">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">title</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.title" title="Link to this definition">¶</a></dt>
<dd><p>Title of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.tzname">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tzname</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.tzname" title="Link to this definition">¶</a></dt>
<dd><p>Timezone name for the asset creation date</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.tzoffset">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">tzoffset</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.tzoffset" title="Link to this definition">¶</a></dt>
<dd><p>TZ Offset from GMT in seconds</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.uti">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uti</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.uti" title="Link to this definition">¶</a></dt>
<dd><p>UTI of current version of photo (edited if hasadjustments, otherwise original)</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.uti_edited">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uti_edited</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.uti_edited" title="Link to this definition">¶</a></dt>
<dd><p>UTI of edited version of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.uti_original">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uti_original</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.uti_original" title="Link to this definition">¶</a></dt>
<dd><p>UTI of original version of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.uti_raw">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uti_raw</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.uti_raw" title="Link to this definition">¶</a></dt>
<dd><p>UTI of raw version of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.uuid">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">uuid</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.uuid" title="Link to this definition">¶</a></dt>
<dd><p>UUID of photo</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.visible">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">visible</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.visible" title="Link to this definition">¶</a></dt>
<dd><p>True if photo is visible in Photos; always returns False for iPhoto</p>
</dd></dl>

<dl class="py property">
<dt class="sig sig-object py" id="osxphotos.iPhotoPhotoInfo.width">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">width</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#osxphotos.iPhotoPhotoInfo.width" title="Link to this definition">¶</a></dt>
<dd><p>Width of photo in pixels</p>
</dd></dl>

</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="osxphotos.is_debug">
<span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">is_debug</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/debug.html#is_debug"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.is_debug" title="Link to this definition">¶</a></dt>
<dd><p>return debug flag</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="osxphotos.set_debug">
<span class="sig-prename descclassname"><span class="pre">osxphotos.</span></span><span class="sig-name descname"><span class="pre">set_debug</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/osxphotos/debug.html#set_debug"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.set_debug" title="Link to this definition">¶</a></dt>
<dd><p>set debug flag</p>
</dd></dl>

</section>

        </article>
      </div>
      <footer>
        
        <div class="related-pages">
          
          <a class="prev-page" href="API_README.html">
              <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
              <div class="page-info">
                <div class="context">
                  <span>Previous</span>
                </div>
                
                <div class="title">OSXPhotos Python API</div>
                
              </div>
            </a>
        </div>
        <div class="bottom-of-page">
          <div class="left-details">
            <div class="copyright">
                Copyright &#169; 2021, Rhet Turnbull
            </div>
            Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
            
            <a href="https://github.com/pradyunsg/furo">Furo</a>
            
          </div>
          <div class="right-details">
            
          </div>
        </div>
        
      </footer>
    </div>
    <aside class="toc-drawer">
      
      
      <div class="toc-sticky toc-scroll">
        <div class="toc-title-container">
          <span class="toc-title">
            On this page
          </span>
        </div>
        <div class="toc-tree-container">
          <div class="toc-tree">
            <ul>
<li><a class="reference internal" href="#">OSXPhotos Python Reference</a><ul>
<li><a class="reference internal" href="#osxphotos.AlbumInfo"><code class="docutils literal notranslate"><span class="pre">AlbumInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.AlbumInfo.asdict"><code class="docutils literal notranslate"><span class="pre">AlbumInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.AlbumInfo.folder_list"><code class="docutils literal notranslate"><span class="pre">AlbumInfo.folder_list</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.AlbumInfo.folder_names"><code class="docutils literal notranslate"><span class="pre">AlbumInfo.folder_names</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.AlbumInfo.parent"><code class="docutils literal notranslate"><span class="pre">AlbumInfo.parent</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.AlbumInfo.photo_index"><code class="docutils literal notranslate"><span class="pre">AlbumInfo.photo_index()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.AlbumInfo.photos"><code class="docutils literal notranslate"><span class="pre">AlbumInfo.photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.AlbumInfo.sort_order"><code class="docutils literal notranslate"><span class="pre">AlbumInfo.sort_order</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.AlbumInfo.title"><code class="docutils literal notranslate"><span class="pre">AlbumInfo.title</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.AlbumSortOrder"><code class="docutils literal notranslate"><span class="pre">AlbumSortOrder</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.CommentInfo"><code class="docutils literal notranslate"><span class="pre">CommentInfo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifInfo"><code class="docutils literal notranslate"><span class="pre">ExifInfo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifTool"><code class="docutils literal notranslate"><span class="pre">ExifTool</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.ExifTool.addvalues"><code class="docutils literal notranslate"><span class="pre">ExifTool.addvalues()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifTool.asdict"><code class="docutils literal notranslate"><span class="pre">ExifTool.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifTool.json"><code class="docutils literal notranslate"><span class="pre">ExifTool.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifTool.pid"><code class="docutils literal notranslate"><span class="pre">ExifTool.pid</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifTool.run_commands"><code class="docutils literal notranslate"><span class="pre">ExifTool.run_commands()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifTool.setvalue"><code class="docutils literal notranslate"><span class="pre">ExifTool.setvalue()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifTool.version"><code class="docutils literal notranslate"><span class="pre">ExifTool.version</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.ExifWriter"><code class="docutils literal notranslate"><span class="pre">ExifWriter</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.ExifWriter.exiftool_dict"><code class="docutils literal notranslate"><span class="pre">ExifWriter.exiftool_dict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifWriter.exiftool_json_sidecar"><code class="docutils literal notranslate"><span class="pre">ExifWriter.exiftool_json_sidecar()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExifWriter.write_exif_data"><code class="docutils literal notranslate"><span class="pre">ExifWriter.write_exif_data()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.ExportDB"><code class="docutils literal notranslate"><span class="pre">ExportDB</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.ExportDB.close"><code class="docutils literal notranslate"><span class="pre">ExportDB.close()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.connection"><code class="docutils literal notranslate"><span class="pre">ExportDB.connection</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.create_file_record"><code class="docutils literal notranslate"><span class="pre">ExportDB.create_file_record()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.create_or_get_file_record"><code class="docutils literal notranslate"><span class="pre">ExportDB.create_or_get_file_record()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.delete_data_for_filepath"><code class="docutils literal notranslate"><span class="pre">ExportDB.delete_data_for_filepath()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.delete_data_for_uuid"><code class="docutils literal notranslate"><span class="pre">ExportDB.delete_data_for_uuid()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.export_dir"><code class="docutils literal notranslate"><span class="pre">ExportDB.export_dir</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_export_results"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_export_results()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_exported_files"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_exported_files()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_file_record"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_file_record()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_files_for_uuid"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_files_for_uuid()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_history"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_history()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_last_export_directory"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_last_export_directory()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_photoinfo_for_uuid"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_photoinfo_for_uuid()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_previous_uuids"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_previous_uuids()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_target_for_file"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_target_for_file()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.get_uuid_for_file"><code class="docutils literal notranslate"><span class="pre">ExportDB.get_uuid_for_file()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.path"><code class="docutils literal notranslate"><span class="pre">ExportDB.path</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.set_config"><code class="docutils literal notranslate"><span class="pre">ExportDB.set_config()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.set_export_results"><code class="docutils literal notranslate"><span class="pre">ExportDB.set_export_results()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.set_history"><code class="docutils literal notranslate"><span class="pre">ExportDB.set_history()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportDB.set_photoinfo_for_uuid"><code class="docutils literal notranslate"><span class="pre">ExportDB.set_photoinfo_for_uuid()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.ExportDBTemp"><code class="docutils literal notranslate"><span class="pre">ExportDBTemp</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions"><code class="docutils literal notranslate"><span class="pre">ExportOptions</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.ExportOptions.convert_to_jpeg"><code class="docutils literal notranslate"><span class="pre">ExportOptions.convert_to_jpeg</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.description_template"><code class="docutils literal notranslate"><span class="pre">ExportOptions.description_template</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.download_missing"><code class="docutils literal notranslate"><span class="pre">ExportOptions.download_missing</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.dry_run"><code class="docutils literal notranslate"><span class="pre">ExportOptions.dry_run</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.edited"><code class="docutils literal notranslate"><span class="pre">ExportOptions.edited</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.exiftool_flags"><code class="docutils literal notranslate"><span class="pre">ExportOptions.exiftool_flags</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.exiftool_path"><code class="docutils literal notranslate"><span class="pre">ExportOptions.exiftool_path</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.exiftool"><code class="docutils literal notranslate"><span class="pre">ExportOptions.exiftool</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.export_as_hardlink"><code class="docutils literal notranslate"><span class="pre">ExportOptions.export_as_hardlink</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.export_db"><code class="docutils literal notranslate"><span class="pre">ExportOptions.export_db</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.face_regions"><code class="docutils literal notranslate"><span class="pre">ExportOptions.face_regions</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.fileutil"><code class="docutils literal notranslate"><span class="pre">ExportOptions.fileutil</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.force_update"><code class="docutils literal notranslate"><span class="pre">ExportOptions.force_update</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.ignore_date_modified"><code class="docutils literal notranslate"><span class="pre">ExportOptions.ignore_date_modified</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.ignore_signature"><code class="docutils literal notranslate"><span class="pre">ExportOptions.ignore_signature</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.increment"><code class="docutils literal notranslate"><span class="pre">ExportOptions.increment</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.jpeg_ext"><code class="docutils literal notranslate"><span class="pre">ExportOptions.jpeg_ext</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.jpeg_quality"><code class="docutils literal notranslate"><span class="pre">ExportOptions.jpeg_quality</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.keyword_template"><code class="docutils literal notranslate"><span class="pre">ExportOptions.keyword_template</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.live_photo"><code class="docutils literal notranslate"><span class="pre">ExportOptions.live_photo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.location"><code class="docutils literal notranslate"><span class="pre">ExportOptions.location</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.merge_exif_keywords"><code class="docutils literal notranslate"><span class="pre">ExportOptions.merge_exif_keywords</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.merge_exif_persons"><code class="docutils literal notranslate"><span class="pre">ExportOptions.merge_exif_persons</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.overwrite"><code class="docutils literal notranslate"><span class="pre">ExportOptions.overwrite</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.persons"><code class="docutils literal notranslate"><span class="pre">ExportOptions.persons</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.preview_suffix"><code class="docutils literal notranslate"><span class="pre">ExportOptions.preview_suffix</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.preview"><code class="docutils literal notranslate"><span class="pre">ExportOptions.preview</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.raw_photo"><code class="docutils literal notranslate"><span class="pre">ExportOptions.raw_photo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.render_options"><code class="docutils literal notranslate"><span class="pre">ExportOptions.render_options</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.replace_keywords"><code class="docutils literal notranslate"><span class="pre">ExportOptions.replace_keywords</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.rich"><code class="docutils literal notranslate"><span class="pre">ExportOptions.rich</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.export_aae"><code class="docutils literal notranslate"><span class="pre">ExportOptions.export_aae</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.sidecar_drop_ext"><code class="docutils literal notranslate"><span class="pre">ExportOptions.sidecar_drop_ext</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.sidecar"><code class="docutils literal notranslate"><span class="pre">ExportOptions.sidecar</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.strip"><code class="docutils literal notranslate"><span class="pre">ExportOptions.strip</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.timeout"><code class="docutils literal notranslate"><span class="pre">ExportOptions.timeout</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.touch_file"><code class="docutils literal notranslate"><span class="pre">ExportOptions.touch_file</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.update"><code class="docutils literal notranslate"><span class="pre">ExportOptions.update</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.update_errors"><code class="docutils literal notranslate"><span class="pre">ExportOptions.update_errors</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.use_albums_as_keywords"><code class="docutils literal notranslate"><span class="pre">ExportOptions.use_albums_as_keywords</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.use_persons_as_keywords"><code class="docutils literal notranslate"><span class="pre">ExportOptions.use_persons_as_keywords</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.use_photos_export"><code class="docutils literal notranslate"><span class="pre">ExportOptions.use_photos_export</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.use_photokit"><code class="docutils literal notranslate"><span class="pre">ExportOptions.use_photokit</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.verbose"><code class="docutils literal notranslate"><span class="pre">ExportOptions.verbose</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.tmpdir"><code class="docutils literal notranslate"><span class="pre">ExportOptions.tmpdir</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.favorite_rating"><code class="docutils literal notranslate"><span class="pre">ExportOptions.favorite_rating</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.fix_orientation"><code class="docutils literal notranslate"><span class="pre">ExportOptions.fix_orientation</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.sidecar_template"><code class="docutils literal notranslate"><span class="pre">ExportOptions.sidecar_template</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportOptions.bit_flags"><code class="docutils literal notranslate"><span class="pre">ExportOptions.bit_flags</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.ExportResults"><code class="docutils literal notranslate"><span class="pre">ExportResults</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.ExportResults.all_files"><code class="docutils literal notranslate"><span class="pre">ExportResults.all_files()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportResults.attributes"><code class="docutils literal notranslate"><span class="pre">ExportResults.attributes</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ExportResults.datetime"><code class="docutils literal notranslate"><span class="pre">ExportResults.datetime</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.FaceInfo"><code class="docutils literal notranslate"><span class="pre">FaceInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.FaceInfo.asdict"><code class="docutils literal notranslate"><span class="pre">FaceInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.center"><code class="docutils literal notranslate"><span class="pre">FaceInfo.center</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.face_rect"><code class="docutils literal notranslate"><span class="pre">FaceInfo.face_rect()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.json"><code class="docutils literal notranslate"><span class="pre">FaceInfo.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.mpri_reg_rect"><code class="docutils literal notranslate"><span class="pre">FaceInfo.mpri_reg_rect</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.mwg_rs_area"><code class="docutils literal notranslate"><span class="pre">FaceInfo.mwg_rs_area</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.person_info"><code class="docutils literal notranslate"><span class="pre">FaceInfo.person_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.photo"><code class="docutils literal notranslate"><span class="pre">FaceInfo.photo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.pitch"><code class="docutils literal notranslate"><span class="pre">FaceInfo.pitch</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.roll"><code class="docutils literal notranslate"><span class="pre">FaceInfo.roll</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.roll_pitch_yaw"><code class="docutils literal notranslate"><span class="pre">FaceInfo.roll_pitch_yaw()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.size_pixels"><code class="docutils literal notranslate"><span class="pre">FaceInfo.size_pixels</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FaceInfo.yaw"><code class="docutils literal notranslate"><span class="pre">FaceInfo.yaw</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.FileUtil"><code class="docutils literal notranslate"><span class="pre">FileUtil</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.convert_to_jpeg"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.convert_to_jpeg()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.copy"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.copy()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.file_sig"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.file_sig()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.hardlink"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.hardlink()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.rename"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.rename()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.rmdir"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.rmdir()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.tmpdir"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.tmpdir()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.unlink"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.unlink()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FileUtilNoOp.utime"><code class="docutils literal notranslate"><span class="pre">FileUtilNoOp.utime()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.FolderInfo"><code class="docutils literal notranslate"><span class="pre">FolderInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.FolderInfo.album_info"><code class="docutils literal notranslate"><span class="pre">FolderInfo.album_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FolderInfo.asdict"><code class="docutils literal notranslate"><span class="pre">FolderInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FolderInfo.parent"><code class="docutils literal notranslate"><span class="pre">FolderInfo.parent</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FolderInfo.subfolders"><code class="docutils literal notranslate"><span class="pre">FolderInfo.subfolders</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FolderInfo.title"><code class="docutils literal notranslate"><span class="pre">FolderInfo.title</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.FolderInfo.uuid"><code class="docutils literal notranslate"><span class="pre">FolderInfo.uuid</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.ImportInfo"><code class="docutils literal notranslate"><span class="pre">ImportInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.ImportInfo.asdict"><code class="docutils literal notranslate"><span class="pre">ImportInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ImportInfo.photos"><code class="docutils literal notranslate"><span class="pre">ImportInfo.photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ImportInfo.title"><code class="docutils literal notranslate"><span class="pre">ImportInfo.title</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.LikeInfo"><code class="docutils literal notranslate"><span class="pre">LikeInfo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo"><code class="docutils literal notranslate"><span class="pre">MomentInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.MomentInfo.asdict"><code class="docutils literal notranslate"><span class="pre">MomentInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.date"><code class="docutils literal notranslate"><span class="pre">MomentInfo.date</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.end_date"><code class="docutils literal notranslate"><span class="pre">MomentInfo.end_date</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.location"><code class="docutils literal notranslate"><span class="pre">MomentInfo.location</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.modification_date"><code class="docutils literal notranslate"><span class="pre">MomentInfo.modification_date</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.photos"><code class="docutils literal notranslate"><span class="pre">MomentInfo.photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.pk"><code class="docutils literal notranslate"><span class="pre">MomentInfo.pk</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.start_date"><code class="docutils literal notranslate"><span class="pre">MomentInfo.start_date</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.subtitle"><code class="docutils literal notranslate"><span class="pre">MomentInfo.subtitle</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.MomentInfo.title"><code class="docutils literal notranslate"><span class="pre">MomentInfo.title</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.PersonInfo"><code class="docutils literal notranslate"><span class="pre">PersonInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.PersonInfo.asdict"><code class="docutils literal notranslate"><span class="pre">PersonInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PersonInfo.face_info"><code class="docutils literal notranslate"><span class="pre">PersonInfo.face_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PersonInfo.favorite"><code class="docutils literal notranslate"><span class="pre">PersonInfo.favorite</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PersonInfo.feature_less"><code class="docutils literal notranslate"><span class="pre">PersonInfo.feature_less</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PersonInfo.json"><code class="docutils literal notranslate"><span class="pre">PersonInfo.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PersonInfo.photos"><code class="docutils literal notranslate"><span class="pre">PersonInfo.photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PersonInfo.sort_order"><code class="docutils literal notranslate"><span class="pre">PersonInfo.sort_order</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.PhotoExporter"><code class="docutils literal notranslate"><span class="pre">PhotoExporter</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.PhotoExporter.export"><code class="docutils literal notranslate"><span class="pre">PhotoExporter.export()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoExporter.write_exiftool_metadata_to_file"><code class="docutils literal notranslate"><span class="pre">PhotoExporter.write_exiftool_metadata_to_file()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo"><code class="docutils literal notranslate"><span class="pre">PhotoInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.adjustment_type"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.adjustment_type</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.adjustments"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.adjustments</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.adjustments_path"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.adjustments_path</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.ai_caption"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.ai_caption</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.album_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.album_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.albums"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.albums</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.asdict"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.burst"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.burst</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.burst_album_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.burst_album_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.burst_albums"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.burst_albums</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.burst_default_pick"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.burst_default_pick</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.burst_key"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.burst_key</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.burst_photos"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.burst_photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.burst_selected"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.burst_selected</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.cloud_guid"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.cloud_guid</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.cloud_metadata"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.cloud_metadata</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.cloud_owner_hashed_id"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.cloud_owner_hashed_id</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.comments"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.comments</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.date"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.date</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.date_added"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.date_added</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.date_modified"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.date_modified</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.date_original"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.date_original</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.date_trashed"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.date_trashed</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.description"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.description</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.detected_text"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.detected_text()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.duplicates"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.duplicates</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.exif_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.exif_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.exiftool"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.exiftool</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.export"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.export()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.external_edit"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.external_edit</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.face_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.face_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.favorite"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.favorite</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.filename"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.filename</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.fingerprint"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.fingerprint</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.flagged"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.flagged</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.has_raw"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.has_raw</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.hasadjustments"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.hasadjustments</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.hdr"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.hdr</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.height"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.height</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.hexdigest"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.hexdigest</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.hidden"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.hidden</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.import_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.import_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.incloud"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.incloud</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.intrash"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.intrash</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.iscloudasset"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.iscloudasset</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.ismissing"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.ismissing</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.ismovie"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.ismovie</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.isphoto"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.isphoto</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.israw"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.israw</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.isreference"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.isreference</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.json"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.keywords"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.keywords</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.labels"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.labels</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.labels_normalized"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.labels_normalized</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.latitude"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.latitude</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.likes"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.likes</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.live_photo"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.live_photo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.location"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.location</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.longitude"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.longitude</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.media_analysis"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.media_analysis</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.moment_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.moment_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.orientation"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.orientation</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.original_filename"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.original_filename</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.original_filesize"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.original_filesize</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.original_height"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.original_height</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.original_orientation"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.original_orientation</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.original_width"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.original_width</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.owner"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.owner</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.panorama"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.panorama</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.path"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.path</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.path_derivatives"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.path_derivatives</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.path_edited"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.path_edited</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.path_edited_live_photo"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.path_edited_live_photo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.path_live_photo"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.path_live_photo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.path_raw"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.path_raw</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.person_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.person_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.persons"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.persons</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.place"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.place</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.portrait"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.portrait</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.project_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.project_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.rating"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.rating</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.raw_original"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.raw_original</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.render_template"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.render_template()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.saved_to_library"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.saved_to_library</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.score"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.score</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.screen_recording"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.screen_recording</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.screenshot"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.screenshot</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.search_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.search_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.search_info_normalized"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.search_info_normalized</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.selfie"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.selfie</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.share_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.share_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.share_participant_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.share_participant_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.share_participants"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.share_participants</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.shared"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.shared</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.shared_library"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.shared_library</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.shared_moment"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.shared_moment</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.shared_moment_info"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.shared_moment_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.slow_mo"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.slow_mo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.syndicated"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.syndicated</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.tables"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.tables()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.time_lapse"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.time_lapse</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.title"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.title</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.tzname"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.tzname</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.tzoffset"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.tzoffset</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.uti"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.uti</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.uti_edited"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.uti_edited</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.uti_original"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.uti_original</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.uti_raw"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.uti_raw</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.uuid"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.uuid</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.visible"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.visible</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoInfo.width"><code class="docutils literal notranslate"><span class="pre">PhotoInfo.width</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.expand_variables"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.expand_variables()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.expand_variables_to_str"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.expand_variables_to_str()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.filter_predicate"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.filter_predicate()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_field_values"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_field_values()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_filter_values"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_filter_values()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_format_values"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_format_values()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_media_type"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_media_type()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_photo_bool_attribute"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_photo_bool_attribute()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_photo_video_type"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_photo_video_type()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_template_value"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_template_value()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_template_value_exiftool"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_template_value_exiftool()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_template_value_filter_function"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_template_value_filter_function()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_template_value_function"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_template_value_function()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_template_value_multi"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_template_value_multi()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.get_template_value_pathlib"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.get_template_value_pathlib()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotoTemplate.render"><code class="docutils literal notranslate"><span class="pre">PhotoTemplate.render()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.PhotosAlbum"><code class="docutils literal notranslate"><span class="pre">PhotosAlbum</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.PhotosAlbum.append"><code class="docutils literal notranslate"><span class="pre">PhotosAlbum.append()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosAlbum.extend"><code class="docutils literal notranslate"><span class="pre">PhotosAlbum.extend()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.PhotosAlbumPhotoScript"><code class="docutils literal notranslate"><span class="pre">PhotosAlbumPhotoScript</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.PhotosAlbumPhotoScript.append"><code class="docutils literal notranslate"><span class="pre">PhotosAlbumPhotoScript.append()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosAlbumPhotoScript.extend"><code class="docutils literal notranslate"><span class="pre">PhotosAlbumPhotoScript.extend()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.PhotosDB"><code class="docutils literal notranslate"><span class="pre">PhotosDB</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.PhotosDB.album_info"><code class="docutils literal notranslate"><span class="pre">PhotosDB.album_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.album_info_shared"><code class="docutils literal notranslate"><span class="pre">PhotosDB.album_info_shared</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.albums"><code class="docutils literal notranslate"><span class="pre">PhotosDB.albums</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.albums_as_dict"><code class="docutils literal notranslate"><span class="pre">PhotosDB.albums_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.albums_shared"><code class="docutils literal notranslate"><span class="pre">PhotosDB.albums_shared</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.albums_shared_as_dict"><code class="docutils literal notranslate"><span class="pre">PhotosDB.albums_shared_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.db_path"><code class="docutils literal notranslate"><span class="pre">PhotosDB.db_path</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.db_version"><code class="docutils literal notranslate"><span class="pre">PhotosDB.db_version</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.execute"><code class="docutils literal notranslate"><span class="pre">PhotosDB.execute()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.folder_info"><code class="docutils literal notranslate"><span class="pre">PhotosDB.folder_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.folders"><code class="docutils literal notranslate"><span class="pre">PhotosDB.folders</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.get_db_connection"><code class="docutils literal notranslate"><span class="pre">PhotosDB.get_db_connection()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.get_photo"><code class="docutils literal notranslate"><span class="pre">PhotosDB.get_photo()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.import_info"><code class="docutils literal notranslate"><span class="pre">PhotosDB.import_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.keywords"><code class="docutils literal notranslate"><span class="pre">PhotosDB.keywords</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.keywords_as_dict"><code class="docutils literal notranslate"><span class="pre">PhotosDB.keywords_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.keywords_without_photo"><code class="docutils literal notranslate"><span class="pre">PhotosDB.keywords_without_photo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.labels"><code class="docutils literal notranslate"><span class="pre">PhotosDB.labels</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.labels_as_dict"><code class="docutils literal notranslate"><span class="pre">PhotosDB.labels_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.labels_normalized"><code class="docutils literal notranslate"><span class="pre">PhotosDB.labels_normalized</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.labels_normalized_as_dict"><code class="docutils literal notranslate"><span class="pre">PhotosDB.labels_normalized_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.library_path"><code class="docutils literal notranslate"><span class="pre">PhotosDB.library_path</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.person_info"><code class="docutils literal notranslate"><span class="pre">PhotosDB.person_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.persons"><code class="docutils literal notranslate"><span class="pre">PhotosDB.persons</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.persons_as_dict"><code class="docutils literal notranslate"><span class="pre">PhotosDB.persons_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.photos"><code class="docutils literal notranslate"><span class="pre">PhotosDB.photos()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.photos_by_uuid"><code class="docutils literal notranslate"><span class="pre">PhotosDB.photos_by_uuid()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.photos_version"><code class="docutils literal notranslate"><span class="pre">PhotosDB.photos_version</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.project_info"><code class="docutils literal notranslate"><span class="pre">PhotosDB.project_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PhotosDB.query"><code class="docutils literal notranslate"><span class="pre">PhotosDB.query()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.PlaceInfo"><code class="docutils literal notranslate"><span class="pre">PlaceInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.PlaceInfo.address"><code class="docutils literal notranslate"><span class="pre">PlaceInfo.address</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PlaceInfo.address_str"><code class="docutils literal notranslate"><span class="pre">PlaceInfo.address_str</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PlaceInfo.asdict"><code class="docutils literal notranslate"><span class="pre">PlaceInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PlaceInfo.country_code"><code class="docutils literal notranslate"><span class="pre">PlaceInfo.country_code</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PlaceInfo.ishome"><code class="docutils literal notranslate"><span class="pre">PlaceInfo.ishome</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PlaceInfo.name"><code class="docutils literal notranslate"><span class="pre">PlaceInfo.name</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.PlaceInfo.names"><code class="docutils literal notranslate"><span class="pre">PlaceInfo.names</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.ProjectInfo"><code class="docutils literal notranslate"><span class="pre">ProjectInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.ProjectInfo.folder_list"><code class="docutils literal notranslate"><span class="pre">ProjectInfo.folder_list</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.ProjectInfo.folder_names"><code class="docutils literal notranslate"><span class="pre">ProjectInfo.folder_names</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.QueryOptions"><code class="docutils literal notranslate"><span class="pre">QueryOptions</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.QueryOptions.added_after"><code class="docutils literal notranslate"><span class="pre">QueryOptions.added_after</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.added_before"><code class="docutils literal notranslate"><span class="pre">QueryOptions.added_before</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.added_in_last"><code class="docutils literal notranslate"><span class="pre">QueryOptions.added_in_last</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.album"><code class="docutils literal notranslate"><span class="pre">QueryOptions.album</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.burst_photos"><code class="docutils literal notranslate"><span class="pre">QueryOptions.burst_photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.burst"><code class="docutils literal notranslate"><span class="pre">QueryOptions.burst</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.cloudasset"><code class="docutils literal notranslate"><span class="pre">QueryOptions.cloudasset</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.deleted_only"><code class="docutils literal notranslate"><span class="pre">QueryOptions.deleted_only</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.deleted"><code class="docutils literal notranslate"><span class="pre">QueryOptions.deleted</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.description"><code class="docutils literal notranslate"><span class="pre">QueryOptions.description</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.duplicate"><code class="docutils literal notranslate"><span class="pre">QueryOptions.duplicate</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.edited"><code class="docutils literal notranslate"><span class="pre">QueryOptions.edited</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.exif"><code class="docutils literal notranslate"><span class="pre">QueryOptions.exif</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.external_edit"><code class="docutils literal notranslate"><span class="pre">QueryOptions.external_edit</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.favorite"><code class="docutils literal notranslate"><span class="pre">QueryOptions.favorite</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.folder"><code class="docutils literal notranslate"><span class="pre">QueryOptions.folder</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.from_date"><code class="docutils literal notranslate"><span class="pre">QueryOptions.from_date</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.from_time"><code class="docutils literal notranslate"><span class="pre">QueryOptions.from_time</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.function"><code class="docutils literal notranslate"><span class="pre">QueryOptions.function</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.has_comment"><code class="docutils literal notranslate"><span class="pre">QueryOptions.has_comment</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.has_likes"><code class="docutils literal notranslate"><span class="pre">QueryOptions.has_likes</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.has_raw"><code class="docutils literal notranslate"><span class="pre">QueryOptions.has_raw</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.hdr"><code class="docutils literal notranslate"><span class="pre">QueryOptions.hdr</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.hidden"><code class="docutils literal notranslate"><span class="pre">QueryOptions.hidden</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.ignore_case"><code class="docutils literal notranslate"><span class="pre">QueryOptions.ignore_case</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.in_album"><code class="docutils literal notranslate"><span class="pre">QueryOptions.in_album</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.incloud"><code class="docutils literal notranslate"><span class="pre">QueryOptions.incloud</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.is_reference"><code class="docutils literal notranslate"><span class="pre">QueryOptions.is_reference</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.keyword"><code class="docutils literal notranslate"><span class="pre">QueryOptions.keyword</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.label"><code class="docutils literal notranslate"><span class="pre">QueryOptions.label</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.live"><code class="docutils literal notranslate"><span class="pre">QueryOptions.live</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.location"><code class="docutils literal notranslate"><span class="pre">QueryOptions.location</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.max_size"><code class="docutils literal notranslate"><span class="pre">QueryOptions.max_size</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.min_size"><code class="docutils literal notranslate"><span class="pre">QueryOptions.min_size</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.missing_bursts"><code class="docutils literal notranslate"><span class="pre">QueryOptions.missing_bursts</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.missing"><code class="docutils literal notranslate"><span class="pre">QueryOptions.missing</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.movies"><code class="docutils literal notranslate"><span class="pre">QueryOptions.movies</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.name"><code class="docutils literal notranslate"><span class="pre">QueryOptions.name</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.no_comment"><code class="docutils literal notranslate"><span class="pre">QueryOptions.no_comment</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.no_description"><code class="docutils literal notranslate"><span class="pre">QueryOptions.no_description</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.no_likes"><code class="docutils literal notranslate"><span class="pre">QueryOptions.no_likes</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.no_location"><code class="docutils literal notranslate"><span class="pre">QueryOptions.no_location</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.no_keyword"><code class="docutils literal notranslate"><span class="pre">QueryOptions.no_keyword</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.no_place"><code class="docutils literal notranslate"><span class="pre">QueryOptions.no_place</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.no_title"><code class="docutils literal notranslate"><span class="pre">QueryOptions.no_title</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_burst"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_burst</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_cloudasset"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_cloudasset</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_edited"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_edited</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_favorite"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_favorite</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_hdr"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_hdr</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_hidden"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_hidden</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_in_album"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_in_album</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_incloud"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_incloud</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_live"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_live</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_missing"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_missing</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_panorama"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_panorama</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_portrait"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_portrait</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_reference"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_reference</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_screenshot"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_screenshot</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_screen_recording"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_screen_recording</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_selfie"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_selfie</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_shared"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_shared</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_slow_mo"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_slow_mo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_time_lapse"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_time_lapse</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.panorama"><code class="docutils literal notranslate"><span class="pre">QueryOptions.panorama</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.person"><code class="docutils literal notranslate"><span class="pre">QueryOptions.person</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.photos"><code class="docutils literal notranslate"><span class="pre">QueryOptions.photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.place"><code class="docutils literal notranslate"><span class="pre">QueryOptions.place</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.portrait"><code class="docutils literal notranslate"><span class="pre">QueryOptions.portrait</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.query_eval"><code class="docutils literal notranslate"><span class="pre">QueryOptions.query_eval</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.regex"><code class="docutils literal notranslate"><span class="pre">QueryOptions.regex</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.screenshot"><code class="docutils literal notranslate"><span class="pre">QueryOptions.screenshot</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.screen_recording"><code class="docutils literal notranslate"><span class="pre">QueryOptions.screen_recording</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.selected"><code class="docutils literal notranslate"><span class="pre">QueryOptions.selected</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.selfie"><code class="docutils literal notranslate"><span class="pre">QueryOptions.selfie</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.shared"><code class="docutils literal notranslate"><span class="pre">QueryOptions.shared</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.slow_mo"><code class="docutils literal notranslate"><span class="pre">QueryOptions.slow_mo</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.time_lapse"><code class="docutils literal notranslate"><span class="pre">QueryOptions.time_lapse</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.title"><code class="docutils literal notranslate"><span class="pre">QueryOptions.title</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.to_date"><code class="docutils literal notranslate"><span class="pre">QueryOptions.to_date</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.to_time"><code class="docutils literal notranslate"><span class="pre">QueryOptions.to_time</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.uti"><code class="docutils literal notranslate"><span class="pre">QueryOptions.uti</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.uuid"><code class="docutils literal notranslate"><span class="pre">QueryOptions.uuid</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.year"><code class="docutils literal notranslate"><span class="pre">QueryOptions.year</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.syndicated"><code class="docutils literal notranslate"><span class="pre">QueryOptions.syndicated</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_syndicated"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_syndicated</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.saved_to_library"><code class="docutils literal notranslate"><span class="pre">QueryOptions.saved_to_library</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_saved_to_library"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_saved_to_library</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.shared_moment"><code class="docutils literal notranslate"><span class="pre">QueryOptions.shared_moment</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_shared_moment"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_shared_moment</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.shared_library"><code class="docutils literal notranslate"><span class="pre">QueryOptions.shared_library</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.QueryOptions.not_shared_library"><code class="docutils literal notranslate"><span class="pre">QueryOptions.not_shared_library</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.ScoreInfo"><code class="docutils literal notranslate"><span class="pre">ScoreInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.ScoreInfo.asdict"><code class="docutils literal notranslate"><span class="pre">ScoreInfo.asdict()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.SearchInfo"><code class="docutils literal notranslate"><span class="pre">SearchInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.SearchInfo.activities"><code class="docutils literal notranslate"><span class="pre">SearchInfo.activities</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.all"><code class="docutils literal notranslate"><span class="pre">SearchInfo.all</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.asdict"><code class="docutils literal notranslate"><span class="pre">SearchInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.bodies_of_water"><code class="docutils literal notranslate"><span class="pre">SearchInfo.bodies_of_water</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.camera"><code class="docutils literal notranslate"><span class="pre">SearchInfo.camera</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.city"><code class="docutils literal notranslate"><span class="pre">SearchInfo.city</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.country"><code class="docutils literal notranslate"><span class="pre">SearchInfo.country</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.detected_text"><code class="docutils literal notranslate"><span class="pre">SearchInfo.detected_text</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.holidays"><code class="docutils literal notranslate"><span class="pre">SearchInfo.holidays</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.labels"><code class="docutils literal notranslate"><span class="pre">SearchInfo.labels</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.locality_names"><code class="docutils literal notranslate"><span class="pre">SearchInfo.locality_names</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.media_types"><code class="docutils literal notranslate"><span class="pre">SearchInfo.media_types</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.month"><code class="docutils literal notranslate"><span class="pre">SearchInfo.month</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.neighborhoods"><code class="docutils literal notranslate"><span class="pre">SearchInfo.neighborhoods</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.place_names"><code class="docutils literal notranslate"><span class="pre">SearchInfo.place_names</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.season"><code class="docutils literal notranslate"><span class="pre">SearchInfo.season</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.source"><code class="docutils literal notranslate"><span class="pre">SearchInfo.source</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.state"><code class="docutils literal notranslate"><span class="pre">SearchInfo.state</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.state_abbreviation"><code class="docutils literal notranslate"><span class="pre">SearchInfo.state_abbreviation</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.streets"><code class="docutils literal notranslate"><span class="pre">SearchInfo.streets</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.text_found"><code class="docutils literal notranslate"><span class="pre">SearchInfo.text_found</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.venue_types"><code class="docutils literal notranslate"><span class="pre">SearchInfo.venue_types</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.venues"><code class="docutils literal notranslate"><span class="pre">SearchInfo.venues</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SearchInfo.year"><code class="docutils literal notranslate"><span class="pre">SearchInfo.year</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.SidecarWriter"><code class="docutils literal notranslate"><span class="pre">SidecarWriter</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.SidecarWriter.write_sidecar_files"><code class="docutils literal notranslate"><span class="pre">SidecarWriter.write_sidecar_files()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SidecarWriter.write_user_sidecar_files"><code class="docutils literal notranslate"><span class="pre">SidecarWriter.write_user_sidecar_files()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.SidecarWriter.xmp_sidecar"><code class="docutils literal notranslate"><span class="pre">SidecarWriter.xmp_sidecar()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.asdict"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.folder_list"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.folder_list</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.folder_names"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.folder_names</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.json"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.parent"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.parent</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.photo_index"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.photo_index()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.photos"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.sort_order"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.sort_order</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.title"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.title</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoAlbumInfo.uuid"><code class="docutils literal notranslate"><span class="pre">iPhotoAlbumInfo.uuid</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB"><code class="docutils literal notranslate"><span class="pre">iPhotoDB</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.album_info"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.album_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.albums"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.albums</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.albums_as_dict"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.albums_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.db_version"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.db_version</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.get_db_connection"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.get_db_connection()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.get_photo"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.get_photo()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.keywords_as_dict"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.keywords_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.persons_as_dict"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.persons_as_dict</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.photos"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.photos()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.photos_version"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.photos_version</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoDB.query"><code class="docutils literal notranslate"><span class="pre">iPhotoDB.query()</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.asdict"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.center"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.center</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.center_x"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.center_x</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.center_y"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.center_y</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.face_rect"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.face_rect()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.json"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.mpri_reg_rect"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.mpri_reg_rect</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.mwg_rs_area"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.mwg_rs_area</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.name"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.name</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.person_info"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.person_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.pitch"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.pitch</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.quality"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.quality</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.roll"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.roll</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.roll_pitch_yaw"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.roll_pitch_yaw()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.size"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.size</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.size_pixels"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.size_pixels</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFaceInfo.yaw"><code class="docutils literal notranslate"><span class="pre">iPhotoFaceInfo.yaw</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.iPhotoFolderInfo"><code class="docutils literal notranslate"><span class="pre">iPhotoFolderInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.iPhotoFolderInfo.album_info"><code class="docutils literal notranslate"><span class="pre">iPhotoFolderInfo.album_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFolderInfo.asdict"><code class="docutils literal notranslate"><span class="pre">iPhotoFolderInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFolderInfo.json"><code class="docutils literal notranslate"><span class="pre">iPhotoFolderInfo.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFolderInfo.parent"><code class="docutils literal notranslate"><span class="pre">iPhotoFolderInfo.parent</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFolderInfo.subfolders"><code class="docutils literal notranslate"><span class="pre">iPhotoFolderInfo.subfolders</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFolderInfo.title"><code class="docutils literal notranslate"><span class="pre">iPhotoFolderInfo.title</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoFolderInfo.uuid"><code class="docutils literal notranslate"><span class="pre">iPhotoFolderInfo.uuid</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.asdict"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.facecount"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.facecount</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.favorite"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.favorite</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.feature_less"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.feature_less</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.json"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.keyface"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.keyface</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.keyphoto"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.keyphoto</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.name"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.name</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.photos"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.sort_order"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.sort_order</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPersonInfo.uuid"><code class="docutils literal notranslate"><span class="pre">iPhotoPersonInfo.uuid</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo</span></code></a><ul>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.ai_caption"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.ai_caption</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.album_info"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.album_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.albums"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.albums</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.asdict"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.asdict()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.burst"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.burst</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.burst_album_info"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.burst_album_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.burst_albums"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.burst_albums</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.burst_photos"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.burst_photos</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.date"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.date</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.date_added"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.date_added</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.date_modified"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.date_modified</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.date_original"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.date_original</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.description"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.description</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.event_info"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.event_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.exif_info"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.exif_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.exiftool"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.exiftool</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.export"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.export()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.face_info"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.face_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.favorite"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.favorite</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.filename"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.filename</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.fingerprint"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.fingerprint</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.flagged"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.flagged</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.hasadjustments"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.hasadjustments</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.height"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.height</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.hexdigest"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.hexdigest</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.hidden"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.hidden</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.intrash"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.intrash</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.ismissing"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.ismissing</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.ismovie"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.ismovie</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.isphoto"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.isphoto</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.israw"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.israw</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.isreference"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.isreference</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.json"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.json()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.keywords"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.keywords</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.latitude"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.latitude</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.location"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.location</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.longitude"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.longitude</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.media_analysis"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.media_analysis</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.moment_info"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.moment_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.orientation"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.orientation</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.original_filename"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.original_filename</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.original_filesize"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.original_filesize</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.original_height"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.original_height</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.original_width"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.original_width</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.path"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.path</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.path_derivatives"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.path_derivatives</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.path_edited"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.path_edited</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.person_info"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.person_info</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.persons"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.persons</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.rating"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.rating</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.raw_original"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.raw_original</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.render_template"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.render_template()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.title"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.title</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.tzname"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.tzname</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.tzoffset"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.tzoffset</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.uti"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.uti</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.uti_edited"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.uti_edited</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.uti_original"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.uti_original</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.uti_raw"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.uti_raw</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.uuid"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.uuid</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.visible"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.visible</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.iPhotoPhotoInfo.width"><code class="docutils literal notranslate"><span class="pre">iPhotoPhotoInfo.width</span></code></a></li>
</ul>
</li>
<li><a class="reference internal" href="#osxphotos.is_debug"><code class="docutils literal notranslate"><span class="pre">is_debug()</span></code></a></li>
<li><a class="reference internal" href="#osxphotos.set_debug"><code class="docutils literal notranslate"><span class="pre">set_debug()</span></code></a></li>
</ul>
</li>
</ul>

          </div>
        </div>
      </div>
      
      
    </aside>
  </div>
</div><script src="_static/documentation_options.js?v=63568c49"></script>
    <script src="_static/doctools.js?v=9bcbadda"></script>
    <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="_static/scripts/furo.js?v=46bd48cc"></script>
    <script src="_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="_static/copybutton.js?v=f281be69"></script>
    </body>
</html>